Menu
We use Sphinx for documentation within our Linux/OSX python environment, but we have someone on Windows who would like to be able to get an environment in which they can edit and build the Sphinx documentation.
Is it possible to set up Sphinx on windows? I'm guessing the hard part is installing a python environment and all the dependencies, but I have 0 experience with python on windows so somebody might be able to point me to a straightforward way to proceed.
989
You can install Sphinx directly from a clone of the Git repository. This can be done either by cloning the repo and installing from the local clone, on simply installing directly via git. $ git clone https://github.com/sphinx-doc/sphinx $ cd sphinx $ pip install .
This line of thinking makes sense, because Sphinx was created to document Python itself. Sphinx however, is a generic documentation tool that is capable of documenting any software project. The goal of Sphinx is to help you write prose documentation. Prose docs work great for any kind of software you are documenting.
For installing python on windows download Python. Run the executable and you are all set.
If you have pip installed then you can open command prompt and just type
pip install -U Sphinx
If you don't have pip installed then you first need to install it by using the following at the command prompt
python -m pip install -U pip
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
