Sphinx documentation » History » Version 13
Alexander Watzinger, 2022-05-07 16:58
| 1 | 9 | Alexander Watzinger | h1. Sphinx |
|---|---|---|---|
| 2 | 3 | Alexander Watzinger | |
| 3 | 9 | Alexander Watzinger | "Sphinx":http://www.sphinx-doc.org is used to generate the in-application manual. The content of the manual can be changed in the *.rst* ("Restructured text":https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) files at sphinx/source. |
| 4 | 1 | Alexander Watzinger | |
| 5 | 5 | Alexander Watzinger | h2. Edit manual |
| 6 | |||
| 7 | Changes are made in the *.rst* files at *sphinx/source* |
||
| 8 | |||
| 9 | h2. Generate documentation |
||
| 10 | |||
| 11 | 10 | Alexander Watzinger | 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. |
| 12 | 1 | Alexander Watzinger | |
| 13 | <pre>sphinx-build ./sphinx/source/ openatlas/static/manual</pre> |
||
| 14 | |||
| 15 | 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. |
||
| 16 | 13 | Alexander Watzinger | |
| 17 | h2. Install Sphinx |
||
| 18 | |||
| 19 | <pre>apt install python3-sphinx python3-sphinx-rtd-theme</pre> |