Once you have cloned Shouldly to your local machine, the following instructions will walk you through installing the tools necessary to build and test the documentation.
Download python version 2.7.10 or higher.
If you are installing on Windows, add both the Python install directory and the Python scripts directory to your
PATHenvironment variable. For example, if you install Python into the
c:\python34directory, you would add
Install Sphinx by opening a command prompt and running the following Python command. (Note that this operation might take a few minutes to complete.):
pip install sphinx
By default, when you install Sphinx, it will install the ReadTheDocs custom theme automatically. If you need to update the installed version of this theme, you should run:
pip install -U sphinx_rtd_theme
Run the make.bat file using html argument to build the stand-alone version of the project in question:
Once make completes, the generated docs will be in the
_build/htmldirectory. Simply open the
index.htmlfile in your browser to see the built docs for that project.