Build this documentation

This paragraph explains how to build this documentation set and the requirements needed to do so.

Preparation

After installing python and pip <https://pip.pypa.io/en/stable/installing/>, you’re ready to install the required packages for our sphinx documentation. To do so, run the following step by step in a console:

pip install Sphinx
pip install sphinx_rtd_theme
pip install sphinxcontrib-actdiag sphinxcontrib-blockdiag sphinxcontrib-nwdiag sphinxcontrib-seqdiag sphinxcontrib-inheritance

Clean and build

To build your documentation set, you can use simple make commands for the selected targets. We’re only using html at the moment, so to build a new set of html documentation you could simply run the following in the root of our project:

make html

Which will generate our new pages into build/html Other targets, such as pdf, are also supported.

After major changes it’s always a good idea to flush the old content and start with a clean slate, you can do so with a simple:

make clean

Documentation theme

By default our documentation uses a ValueA theme, this can be customized using stylesheets. The procedure how to build your own theme is not part of this documentation.