In-Portal Developers Guide

Preparations

1. install Sphinx: pip install -U sphinx
2. install Read the Docs Sphinx Theme: pip install -U sphinx_rtd_theme
3. install sphinx-autobuild: pip install -U sphinx-autobuild

Automatic building

1. run make livehtml in the docs folder
2. open http://localhost:8000/ to view the documentation

Thanks to the sphinx-autobuild the documentation will be automatically built on every change and all browsers, where it's opened will be reloaded automatically as well.

One-time building

1. run make html in the docs folder
2. open docs/build/html folder in your browser