Sphinx (Software)

aus Wikipedia, der freien Enzyklopädie
Wechseln zu: Navigation, Suche
Sphinx
Entwickler Georg Brandl
Aktuelle Version 1.2.2
(2. März 2014)
Betriebssystem plattformübergreifend
Programmier­sprache Python
Kategorie Software-Dokumentationswerkzeug
Lizenz BSD
sphinx-doc.org

Sphinx ist Software-Dokumentationswerkzeug, welches reStructuredText in HTML-Seiten sowie viele weitere Formate wie PDF, EPub und Manpages umwandelt. Es stützt sich dabei auf die erweiterbare Natur von reStructuredText durch Verwendung zahlreicher Erweiterungen (z.B. für die automatische Dokumentationsgenerierung aus Quelltext, die Darstellung mathematischer Notation oder zur Syntax-Hervorhebung). Der erste öffentliche Release (version 0.1.61611) wurde am 21. März 2008[1] freigegeben. Es war zur Dokumentation des Python-Projekts entwickelt worden, und wird von diesem auch intensiv eingesetzt.[2]

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

Ähnliche Werkzeuge[Bearbeiten]

Einzelnachweise[Bearbeiten]

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

Literatur[Bearbeiten]

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

Weblinks[Bearbeiten]