Sphinx is used to generate the in-application manual. The content of the manual can be changed in the .rst (Restructured text) files at sphinx/source.

Sphinx version 3.4.3

It is important that the Sphinx version 3.4.3 is used to prevent overwriting each other and running into formatting problems. E.g. if installing with pip:

pip3 install sphinx==3.4.3 sphinx-rtd-theme==0.5.1

Editing the manual

After finishing changes, it is a good practice to delete the openatlas/static/manual directory and generate the whole manual again. Otherwise, not all changes (e.g. menu structure) may be propagated correctly.
To avoid issues with different versions and operating systems following workflow is advised:

Install Sphinx

apt install python3-sphinx python3-sphinx-rtd-theme