Sphinx¶
Sphinx ist ein Werkzeug das Dokumentationen einfach und anschaulich machen soll, es wurde von Georg Brandl geschrieben und unter steht unter BSD Lizenz.
Installation¶
Sollte Sphinx in Ihrer Distribution noch nicht enthalten sein können Sie es über den Python-Package Index (PyPi), mithilfe von pip nachinstallieren.
sudo pip install sphinx
Weitere Informationen über Installation und Erweiterung der Pakete können direkt im Python-Package Index abgerufen werden:
Eine neue Dokumentation erstellen¶
Sphinx stellt eine große Zahl von Scripten zur Verfügung, die Sie beim Erstellen
und Bearbeiten von neuen Dokumenten unterstützen. Die einfachste Möglichkeit wie
ein neues Projekt gestartet werden kann, bietet der Aufruf von
sphinx-quickstart in einem Terminal:
sphinx-quickstart
Themes wechseln¶
Sphinx wird mehreren Standard-Themes ausgeliefert, um diese zu wechseln reicht eine kleine Änderung in der Datei source/conf.py:
# die Standard-Einstellung ist "Alabaster", wir stellen den Theme
# zurück auf "classic"
html_theme = 'classic'
Nun sind wir bereit das Setup zu testen, wechseln Sie dazu einfach in Root-
Verzeichnis Ihres Projekts und tippen make html. Dieser Befehl wandelt den
Inhalt aller Quelldatein in ein fertiges HTML-Dokument um, den Einstiegspunkt
bietet wie üblich die Datei index.hmtl.
Sphinx kann aber nicht nur HTML-Dateien ausgeben, eine Liste mit allen möglichen
Ausgabeformaten erhalten Sie wenn sie nur make eintippen.
Sphinx ist ein sehr mächtiges Dokumentswerkzeug, um tiefer in die Sache einzusteigen, schauen Sie sich unbedingt dieses Tutorial an.