Neues Buch: Software-Dokumentation mit Sphinx

Sphinx ist ein leistungsfähiges Werkzeug für die Dokumentation von Software. Ursprünglich geschrieben, um die Programmiersprache Python zu dokumentieren, entwickelte sich Sphinx in der Python-Community schnell zum Standard. Dieses Buch hilft Ihnen beim Einstieg in die Softwaredokumentation mit Sphinx und macht Sie Schritt für Schritt mit den umfangreichen Leistungsmerkmalen des Programms vertraut. Es bietet sowohl Einsteigern als auch fortgeschrittenen Benutzern ein praktisches Handbuch für die tägliche Arbeit.

Seit mehreren Jahren nutzt der Autor des Buches, Jan Ulrich Hasecke, Sphinx zur Dokumentation von Software. So pflegt er beispielsweise das Plone-Benutzerhandbuch mit Sphinx. Die auf Python basierende Software lässt sich jedoch auch zu anderen Zwecken nutzen. »Sphinx ist im Kern ein Single Source Multi-Channel Publishing-Tool, mit dem man Inhalte aus einer Quelle heraus in verschiedenen Zielformaten erstellen kann«, sagt Hasecke, der 2013 ein Buch über den polnischen Filmemacher Krzysztof Kieślowski mit Sphinx produzierte.

Sphinx basiert auf einem einfachen Prinzip. Es generiert aus reStructuredText die gewünschten Zielformate wie HTML, PDF, EPUB, HTML Help, Qt Help, Devhelp, Texinfo oder Manpages. Durch seine Erweiterbarkeit und Flexibilität erobert sich Sphinx immer weitere Einsatzgebiete und empfiehlt sich als praktikable Single-Source Multi-Channel Publishing-Lösung.