Sphinx (Software)

Sphinx
Basisdaten

Entwickler Georg Brandl
Erscheinungsjahr März 2008[1]
Aktuelle Version 9.1.0[2]
(31. Dezember 2025)
Betriebssystem plattformübergreifend
Programmier­sprache 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 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.

Einzelnachweise

  1. ↑ raw.githubusercontent.com.
  2. ↑ Release 9.1.0. 31. Dezember 2025 (abgerufen am 4. April 2026).
  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.

Content Disclaimer

Informasi ini disarikan dari Wikipedia dan disajikan kembali untuk tujuan edukasi. Konten tersedia di bawah lisensi CC BY-SA 3.0. Kami tidak bertanggung jawab atas ketidakakuratan data yang bersumber dari kontribusi publik tersebut.

  1. The information displayed on this website is sourced in part or in whole from Wikipedia and has been adapted for the purpose of restating it. We strive to provide accurate and relevant information, however:
  2. There is no guarantee of absolute accuracy. Wikipedia is an open, collaborative project that can be edited by anyone, so information is subject to change.
  3. It is not intended to constitute professional advice. The content displayed is for informational and educational purposes only. For important decisions (e.g., medical, legal, or financial), please consult a professional.
  4. Content copyright. Wikipedia is licensed under the Creative Commons Attribution-ShareAlike License (CC BY-SA). This means that content may be reused with appropriate attribution and shared under a similar license.
  5. Responsible use. Any risk arising from the use of information from this website is entirely the responsibility of the user.