DocumentationΒΆ

In order to build the documentation locally, you need Sphinx and the Sphinx theme for ReadTheDocs. For convenience, the instructions below include a live-reload server.

First, install the dependencies :

sudo apt-get install python python-pip python-sphinx
sudo pip install sphinx_rtd_theme sphinx-autobuild

Then move to the doc directory and type :

make serve

Finally, visit http://localhost:8000/.