| 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 | ||
| 30defd | 23 | Und die Dokumentation bauen. |
| JUH | 24 | |
| ff43a4 | 25 | Für die HTML-Version: |
| JUH | 26 | |
| 27 | $ cd hs.docs.users | |
| 30defd | 28 | $ sphinx-build -c local -b html source/ build/html |
| ff43a4 | 29 | |
| 30defd | 30 | Die Startseite der Dokumentation lautet: `build/html/index.html` |
