Sphinx (Software)

aus Wikipedia, der freien Enzyklopädie
Wechseln zu: Navigation, Suche
Sphinx
Entwickler Georg Brandl
Aktuelle Version 1.6.3
(2. Juli 2017[1])
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 automatisches Generieren von Dokumentation aus Quelltext, das Darstellen mathematischer Notation oder zur Syntax-Hervorhebung. Der erste öffentliche Release wurde am 21. März 2008[2] freigegeben. Es wurde zur Dokumentation des Python-Projekts entwickelt, und wird von diesem auch intensiv eingesetzt.[3]

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.[4] Um die Wartung von Software-Dokumentationen zu vereinfachen wurde das Read-the-docs-Project gegründet,[5] welches den Prozess des Uploads der aktuellen Dokumentation nach jedem Commit automatisiert. Die Python Software Foundation fördert das Read-the-docs-Projekt.[6]

Literatur[Bearbeiten | Quelltext bearbeiten]

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

Weblinks[Bearbeiten | Quelltext bearbeiten]

Einzelnachweise[Bearbeiten | Quelltext bearbeiten]

  1. sphinx-doc.org
  2. Georg Brandl: Sphinx is released! » And now for something completely Pythonic… Abgerufen am 3. April 2011.
  3. About these documents – Python v2.7.1 documentation. Python Software Foundation; abgerufen am 3. April 2011.
  4. Dev:2.5/Py/API/Generating API Reference – BlenderWiki! Blender Foundation; abgerufen am 6. April 2011.
  5. Eric Holscher: Announcing Read The Docs. 16. August 2010; abgerufen am 6. April 2011.
  6. PSF Funds readthedocs.org. Python Software Foundation, 9. März 2011; abgerufen am 6. April 2011.