Project

General

Profile

Sphinx documentation » History » Version 5

Alexander Watzinger, 2020-04-28 22:07

1 1 Alexander Watzinger
h1. Sphinx documentation
2
3 3 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* files at sphinx/source.
4 1 Alexander Watzinger
5 5 Alexander Watzinger
h2. Install Sphinx
6
7
<pre>apt-get install python3-sphinx python3-sphinx-rtd-theme</pre>
8
9
h2. Edit manual
10
11
Changes are made in the *.rst* files at *sphinx/source*
12
13
h2. Generate documentation
14
15
After editing the HTML sites have to be generated.
16
17
<pre>sphinx-build ./sphinx/source/ openatlas/static/manual