The docs built from master can be viewed here. We need to work on it so, any contribution are welcome. Our (future) template can be found here.

To build the docs, you'll need Sphinx, a theme and some other package

# Start by installing the required packages
cd docs/
pip install -r requirements.txt

Then, you can build the docs and view it

# Build the docs
make html
# View it! (Change firefox by your favorite browser)
firefox build/html/index.html

If you rebuild the docs, don't forget to run make clean before it.

You can add this to your .bashrc, source it and run run_docs from the docs/ folder, that'll be easier.

alias run_docs='make clean; make html; firefox build/html/index.html'