edit | blame | history | raw

Lokale Installation der Dokumentation

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.

README 1 KB
source/_static/robots 25 b
source/einfuehrung/index 6 KB
source/einstieg/benutzer-anlegen 5 KB
source/einstieg/datenbank 3 KB
source/einstieg/domain 3 KB
source/einstieg/email 9 KB
source/einstieg/index 617 b
source/einstieg/passwort 4 KB
source/einstieg/ssh-key 2 KB
source/einstieg/webspace 7 KB
source/glossar 3 KB
source/index 1 KB
source/mail/index 6 KB
source/plattform/backup 590 b
source/plattform/index 280 b
source/plattform/monitoring 350 b
source/plattform/netze 2 KB
source/plattform/rechenzentren 682 b
source/plattform/redundanz 455 b
source/plattform/replikation 548 b
source/referenz/backup 2 KB
source/referenz/benutzer/index 6 KB
source/referenz/datenbanken/datenbank-webfrontend 285 b
source/referenz/datenbanken/datenbank-zugriff 322 b
source/referenz/datenbanken/datenbanken-nutzer 686 b
source/referenz/datenbanken/index 553 b
source/referenz/domain/domain-optionen 3 KB
source/referenz/domain/domainverwaltung 4 KB
source/referenz/domain/index 2 KB
source/referenz/domain/subdomains 2 KB
source/referenz/email/emailalias-paketuser 399 b
source/referenz/email/index 1 KB
source/referenz/email/postausgangsserver 2 KB
source/referenz/email/posteingangsserver 850 b
source/referenz/email/size-email 455 b
source/referenz/email/webmail 259 b
source/referenz/hostkeys 8 KB
source/referenz/hsadmin/domain 4 KB
source/referenz/hsadmin/emailaddress 3 KB
source/referenz/hsadmin/emailaliases 2 KB
source/referenz/hsadmin/index 3 KB
source/referenz/hsadmin/mysqldb 2 KB
source/referenz/hsadmin/mysqluser 2 KB
source/referenz/hsadmin/postgresqldb 2 KB
source/referenz/hsadmin/postgresqluser 2 KB
source/referenz/hsadmin/q 728 b
source/referenz/hsadmin/skript 11 KB
source/referenz/hsadmin/syntax 2 KB
source/referenz/hsadmin/user 3 KB
source/referenz/hsadmin/webfrontend 265 b
source/referenz/htaccess 4 KB
source/referenz/index 467 b
source/referenz/logging/index 3 KB
source/referenz/php 2 KB
source/referenz/tls/eigene-tls-zertifikate 753 b
source/referenz/tls/filemap-mit-ssl 1 KB
source/referenz/tls/filemap-ohne-ssl 1 KB
source/referenz/tls/index 655 b
source/referenz/tls/letsencrypt 1 KB
source/referenz/tls/standard 396 b
source/referenz/tls/varianten 801 b
source/referenz/wartungsfenster 1 KB
source/referenz/webpaket/index 2 KB
source/referenz/webpaket/speicherbelegung 2 KB
source/referenz/webpaket/verzeichnisebenen-domain-admin 7 KB
source/referenz/webpaket/verzeichnisebenen-email-nutzer 720 b
source/referenz/webpaket/verzeichnisebenen-paket-admin 2 KB
source/referenz/zonefile/eigenes-zonefile-deaktivieren 281 b
source/referenz/zonefile/eigenes-zonefile 1 KB
source/referenz/zonefile/expandiertes-standard-zonefile 1 KB
source/referenz/zonefile/expansion-platzhalter 2 KB
source/referenz/zonefile/index 906 b
source/referenz/zonefile/kontrolle-aenderungen 2 KB
source/referenz/zonefile/platzhalter 3 KB