Sphinx (Software)

Sphinx
Basisdaten

EntwicklerGeorg Brandl
ErscheinungsjahrMärz 2008[1]
Aktuelle Version7.3.7[2]
(19. April 2024)
Betriebssystemplattformübergreifend
Programmier­sprachePython
KategorieSoftware-Dokumentationswerkzeug
LizenzBSD
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 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

Einzelnachweise

  1. ↑ raw.githubusercontent.com.
  2. ↑ Release 7.3.7. 19. April 2024 (abgerufen am 25. April 2024).
  3. ↑ Georg Brandl: Sphinx is released! » And now for something completely Pythonic… Archiviert vom Original am 22. März 2012; abgerufen am 3. 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.@1@2Vorlage:Webachiv/IABot/pythonic.pocoo.org
  4. ↑ About these documents – Python v2.7.1 documentation. Python Software Foundation, abgerufen am 3. April 2011.
  5. ↑ Dev:2.5/Py/API/Generating API Reference – BlenderWiki! Blender Foundation, archiviert vom Original (nicht mehr online verfügbar) am 23. Februar 2011; 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.@1@2Vorlage:Webachiv/IABot/wiki.blender.org
  6. ↑ Eric Holscher: Announcing Read The Docs. 16. August 2010, abgerufen am 6. April 2011.
  7. ↑ PSF Funds readthedocs.org. Python Software Foundation, 9. März 2011, abgerufen am 6. April 2011.