5cf7a45 Jun 3, 2018
3 contributors

Users who have contributed to this file

@cytopia @kodemaan @alexmanno
43 lines (27 sloc) 1.02 KB

Devilbox Documentation

The Devilbox documentation is build via sphinx and automatically updated on readthedocs by every git push.


The documentation is available online:

Local setup

You can also build the documentation locally before pushing to ensure everything looks fine:


sudo pip install sphinx sphinx-autobuild
sudo pip install sphinx_rtd_theme

How to build and error-check

cd docs/
sphinx-build -a -E -j auto -n -q . _build/html/

How to build continuously

cd docs/
sphinx-autobuild . _build/html

How to view

Open you browser on