Dies ist eine vorläufige Beschreibung zur Installation der Dokumentation auf einem lokalen Rechner.
Wenn die Dokumentation in unseren Internetauftritt integriert ist, werden andere Schritte nötig sein.
Zuerst eine virtuelle Python-Umgebung erzeugen und aktivieren:
$ python3 -m venv doku
$ . ./doku/bin/activate
Anschließend Sphinx und das Readthedocs-Theme installieren.
Das Theme ist weit verbreitet und gut lesbar.
Bei einer Veröffentlichung wird es vermuitlich ein Theme geben, das mit unserem CD besser übereinstimmt.
Fürs erste eignet sich das Theme gut zum Korrekturlesen.
$ pip install -U Sphinx
$ pip install sphinx_rtd_theme
Dann die Dokumentation mit Git klonen:
$ git clone ssh://DEIN-BENUTZERNAME@dev.hostsharing.net:29418/docs/hs.docs.users.git
Und die Dokumentation bauen.
Für die HTML-Version:
$ cd hs.docs.users
$ make html
Für die PDF-Version:
$ make latexpdf
Um die PDF-Version mit Hilfe von LaTeX zu erzeugen, ist eine sehr umfangreiche LaTeX-Installation notwendig.
Wer mit einer minimalen LaTeX-Installation startet, muss viele Pakete nachinstallieren.
