Project

General

Profile

Actions

Sphinx

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.

Install Sphinx

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

Edit manual

Changes are made in the .rst files at sphinx/source

Generate documentation

After editing the HTML sites have to be generated. To avoid merge conflicts please make changes only in the develop branch and push it afterwards.

sphinx-build ./sphinx/source/ openatlas/static/manual

After finishing changes it is a good practice to delete the openatlas/static/manual directory and generate the whole manual again. Otherwise sometimes not all changes (e.g. menu structure) may be propagated correctly.

Updated by Alexander Watzinger about 1 month ago · 12 revisions

Also available in: PDF HTML TXT