Colophon

Diese Dokumentation ist mit sphinx erstellt. Die Schritte, um an der Doku zu arbeiten sind folgenden

Dieses Repo herunterladen

$ git clone https://github.com/hbz/to.science

Sphinx installieren

Für die Verwendung von Sphinx wird eine virtuelle Pythonumgebung im Verzeichnis venv eingerichtet. Das Verzeichnis sollte nicht mit ins git repo committet werden. Das virtuelle Python wird aktiviert und mit pip die sphinx und die themes sphinx_rtd_theme und furo installiert. Diese sind in der requirments.txt angegeben.

$ cd to.science/docs
$ python3 -m venv ./venv
$ . venv/bin/activate
$ pip install -r requirements.txt

Doku modifizieren und in HTML übersetzen

Die Doku ist in reStructuredText geschrieben wird mittels make in html übersetzt.

$ cd to.science/docs
$ vi source/colophon.rst
$ make html

Das fertige html findet man im Unterverzeichnis build/html. Man kann eine einfachen Webserver starten und das Ergebnis unter http://localhost:8000 ansehen.

$ python3 -m http.server --directory build/html

License

CC BY-NC 4.0

This work is licensed under CC BY-NC 4.0.