Sphinx (Software)
| Sphinx | |
|---|---|
| Basisdaten | |
| Entwickler | Georg Brandl |
| Erscheinungsjahr | März 2008[1] |
| Aktuelle Version | 3.5.3[2] (20. März 2021) |
| Betriebssystem | plattformübergreifend |
| Programmiersprache | Python |
| Kategorie | Software-Dokumentationswerkzeug |
| Lizenz | BSD |
| sphinx-doc.org | |
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 automatische Generieren von Dokumentation aus Quelltext, 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]
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)
Einzelnachweise
- ↑ raw.githubusercontent.com.
- ↑ www.sphinx-doc.org.
- ↑ Georg Brandl: Sphinx is released! » And now for something completely Pythonic… Abgerufen am 3. April 2011.
- ↑ About these documents – Python v2.7.1 documentation. Python Software Foundation, abgerufen am 3. April 2011.
- ↑ Dev:2.5/Py/API/Generating API Reference – BlenderWiki! (Nicht mehr online verfügbar.) Blender Foundation, archiviert vom Original am 26. Januar 2013; abgerufen am 6. April 2011. Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.
- ↑ Eric Holscher: Announcing Read The Docs. 16. August 2010, abgerufen am 6. April 2011.
- ↑ PSF Funds readthedocs.org. Python Software Foundation, 9. März 2011, abgerufen am 6. April 2011.
