Project

General

Profile

Actions

Sphinx documentation » History » Revision 14

« Previous | Revision 14/19 (diff) | Next »
Bernhard Koschiček-Krombholz, 2022-10-07 16:34


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.

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.
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.

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

Install Sphinx

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

Updated by Bernhard Koschiček-Krombholz 4 months ago · 14 revisions

Also available in: PDF HTML TXT