5. Documentation and Sphinx

This documentation is hosted via readthedocs but can also be built using sphinx in a stand-alone way.

To build the documentation do the following starting at the root directory of the repository.

pip install sphinx
sphinx-build --version
sphinx-build -b html docs/source/ docs/build/html

This will build html documentation in docs/build/html/index.html which you can view with your browser.

After making the documentation there will be a Makefile inside the docs/ directory that can be used for further building. You can use the following commands, then, to re-build the html documentation, or build the epub documentation, or latex and pdf documentation.

cd docs/
make html
make epub
make latexpdf