Project

General

Profile

Sphinx documentation » History » Version 11

Alexander Watzinger, 2020-10-23 21:28

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. Install Sphinx
6
7 8 Alexander Watzinger
<pre>apt install python3-sphinx python3-sphinx-rtd-theme</pre>
8 5 Alexander Watzinger
9
h2. Edit manual
10
11
Changes are made in the *.rst* files at *sphinx/source*
12
13
h2. Generate documentation
14
15 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.
16 5 Alexander Watzinger
17 6 Alexander Watzinger
<pre>sphinx-build ./sphinx/source/ openatlas/static/manual</pre>
18
19 11 Alexander Watzinger
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.