Documentation

Documentation should be edited and tested locally. If you push to a remote branch for which there are hooks on readthedocs.org (currently master and nightly), the documentation will be build and updated accordingly.

The documentation is build with sphinx. We use reStructuredText sine it offers more possibilities compared to markdown. Either learn reStructuredText from the website’s quick reference or simply have a look at the source of existing documentation (click on Show Source on the side bar).

If you have not installed sphinx, install it with pip.

pip install sphinx sphinx_rtd_theme

Afterwards go to the doc directory and create the documentation:

cd doc
make clean
make html

Open the html file:

open build/html/index.html

Note

If you encounter problems, try it within a virtualenv.