Install Sphinx, sphinx_rtd_theme and mock with pip.

sudo pip install sphinx>=1.3b1 sphinx_rtd_theme mock

The documentation is generated from ReStructured Text using Sphinx.

The documentation sources are in the doc/ directory. To locally build the documentation, go to the doc/ directory and run:

make html

The built documentation will be in the _build/html/ directory.

The online documentation can be found at Whenever new commits are pushed to the master branch, the docs are rebuilt from this branch (assuming the build doesn’t fail).

Use Google style docstrings for documenting code. These Sections can be used inside the docstrings. For docstring examples, see Example Google Style Python Docstrings or the module lfd.registration.