Jan Ulrich Hasecke
2020-01-06 644996a1e98eb523e3e2d0504ab47bc10f4fb384
commit | author | age
ff43a4 1 # Lokale Installation der Dokumentation
JUH 2
3 Dies ist eine vorläufige Beschreibung zur Installation der Dokumentation auf einem lokalen Rechner.
4 Wenn die Dokumentation in unseren Internetauftritt integriert ist, werden andere Schritte nötig sein.
5
6 Zuerst eine virtuelle Python-Umgebung erzeugen und aktivieren:
7
8     $ python3 -m venv doku
9     $ . ./doku/bin/activate
10
11 Anschließend Sphinx und das Readthedocs-Theme installieren.
12 Das Theme ist weit verbreitet und gut lesbar. 
13 Bei einer Veröffentlichung wird es vermuitlich ein Theme geben, das mit unserem CD besser übereinstimmt.
14 Fürs erste eignet sich das Theme gut zum Korrekturlesen.
15
16     $ pip install -U Sphinx
17     $ pip install sphinx_rtd_theme
18     
19 Dann die Dokumentation mit Git klonen:
20
21     $ git clone ssh://DEIN-BENUTZERNAME@dev.hostsharing.net:29418/docs/hs.docs.users.git
22   
23 Und die Dokumentation bauen.
24 Für die HTML-Version:
25
26     $ cd hs.docs.users
27     $ make html
28
29 Für die PDF-Version:
30
31     $ make latexpdf
32     
33 Um die PDF-Version mit Hilfe von LaTeX zu erzeugen, ist eine sehr umfangreiche LaTeX-Installation notwendig.
34 Wer mit einer minimalen LaTeX-Installation startet, muss viele Pakete nachinstallieren.