Project

General

Profile

Sphinx documentation » History » Revision 3

Revision 2 (Alexander Watzinger, 2020-04-21 20:56) → Revision 3/20 (Alexander Watzinger, 2020-04-21 21:00)

h1. Sphinx documentation

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

*Install Sphinx*<pre>apt-get Execute generation after changes:<pre>sphinx-build ./sphinx/source/ ../openatlas/static/manual -d /tmp/</pre>
Install needed libraries:<pre>apt-get
install python3-sphinx python3-sphinx-rtd-theme</pre>
*Generate documentation from .rst files*<pre>sphinx-build ./sphinx/source/ ../openatlas/static/manual -d /tmp/</pre>