Das Tutorial ist eine Einführung in Sphinx und deckt die Hauptfunktionen sowie einige nützliche Erweiterungen ab. Die Teilnehmer sollten Sphinx im Vorfeld bereits installiert haben. Die Installation der Software ist nicht Teil des Tutorials, da es sehr zeitaufwändig ist, mehrere Betriebssysteme abzudecken.
Sphinx ist ein leistungsfähiges Werkzeug zur Dokumentation von Software, das reStructuredText-Dateien in eine Reihe von Zielformaten wie HTML, PDF und ePub konvertiert. Damit ist Sphinx auch eine interessante Lösung für das Multi-Channel-Publishing. Sphinx hat herausragende Funktionen um Python-Code zu dokumentieren und es unterstützt auch einige andere Sprachen. Sphinx integriert sich gut in den Entwicklungsprozess von Software und bringt Programmierer dazu, Dokumentation schreiben zu wollen. So jedenfalls wird ein Benutzer auf der Homepage von Sphinx zitiert.
- Erstellung und Konfiguration einer neuen Dokumentation (20min)
- Einführung in reStructuredText (20min)
- Aufbau und Gliederung einer Dokumentation (20min)
- Kurze Pause (5min)
- Dokumentation von Python, C, C++, Javascript (40min)
- Automatische Dokumentation (20min)
- Kurze Pause (5min)
- Tabellen, Abbildungen, Formeln (20min)
- Glossar, Index, Referenzen (20min)
- Überblick über Erweiterungen (10min)
