This Documentation

This documentation was built with Sphinx using a theme provided by Read the Docs. The source files are contained in the git repository, under docs/.

How to build and/or change the documentation

• Go to docs/ and install the requirements in requirements.txt

• The sphinx configuration file is conf.py and the documentation content is containes in the .md files in docs/ and docs/user-manual.

• Build the documentation from the root directory via

sphinx-build -b html docs public 

• The html file generated by sphinx can be found in the public folder in the root directory.

• To merge your changes into our gitlab repository, please fill in a merge request and wait for it to be approved. After merging, the documentation will be build automatically through the gitlab CI/CD pipeline and deployed to gitlab Pages.