Creating a static documentation

Each version should include a matching documentation.

Currently, the documentation is built from the github-wiki using MkDocs.

Install mkdocs

Install mkdocs using

pip install mkdocs

Additionally, you need material for mkdocs. Install material for mkdocs using

pip install mkdocs-material

Building the documentation

To build the documentation start the script “build_docs.py” located in the project's “docs” directory. You need Python version 3.0 or higher with mkdocs installed to do so.

...>python build_docs.py

The script will download the wiki, build the docs and start the server.

The documentation is then available at http://127.0.0.1:8000/

To create a static documentation, execute:

...>mkdocs build