Project

General

Profile

Actions

Sphinx documentation » History » Revision 5

« Previous | Revision 5/18 (diff) | Next »
Alexander Watzinger, 2020-04-28 22:07


Sphinx documentation

Sphinx 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

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

Edit manual

Changes are made in the .rst files at sphinx/source

Generate documentation

After editing the HTML sites have to be generated.

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

Updated by Alexander Watzinger almost 3 years ago · 5 revisions

Also available in: PDF HTML TXT