Sphinx (Software)

Sphinx ist ein Software-Dokumentationswerkzeug, welches reStructuredText in HTML-Seiten sowie viele weitere Formate wie PDF, EPUB und Manpages umwandelt. Es nutzt die Erweiterbarkeit von reStructuredText für z. B. das Darstellen mathematischer Notation oder zur Syntax-Hervorhebung. Der erste öffentliche Release wurde am 21. März 2008^[3] freigegeben. Es wurde zur Dokumentation des Python-Projekts entwickelt und wird von diesem auch intensiv eingesetzt.^[4]

Sphinx
Basisdaten
Entwickler	Georg Brandl
Erscheinungsjahr	März 2008[1]
Aktuelle Version	8.2.3[2] (2. März 2025)
Betriebssystem	plattformübergreifend
Programmier­sprache	Python
Kategorie	Software-Dokumentationswerkzeug
Lizenz	BSD
sphinx-doc.org

Seit seiner Einführung im Jahr 2008 wurde Sphinx zunehmend auch in anderen wichtigen Python-basierten Projekten wie Bazaar, SQLAlchemy, MayaVi, Sage, SciPy, Django und Pylons eingesetzt, weiterhin wird es zur Dokumentation der Blender-Python-Programmierschnittstelle verwendet.^[5] Um die Wartung von Software-Dokumentationen zu vereinfachen, wurde das Read-the-docs-Project gegründet,^[6] welches den Prozess des Uploads der aktuellen Dokumentation nach jedem Commit automatisiert. Die Python Software Foundation fördert das Read-the-docs-Projekt.^[7]

Literatur

• Jan Ulrich Hasecke, Georg Brandl: Software-Dokumentation mit Sphinx. CreateSpace Independent Publishing Platform. 2014, ISBN 978-1-4974-4868-1.

Weblinks

• Offizielle Website
• A list of projects using Sphinx (englisch)
• Python Documentation (mit Sphinx generiert, englisch)