Sphinx (Software)

aus Wikipedia, der freien Enzyklopädie
Dies ist eine alte Version dieser Seite, zuletzt bearbeitet am 17. Oktober 2016 um 20:54 Uhr durch Wirbelstrom2k4 (Diskussion | Beiträge) (1.4.8). Sie kann sich erheblich von der aktuellen Version unterscheiden.
Zur Navigation springen Zur Suche springen
Eine gesichtete Version dieser Seite, die am 17. Oktober 2016 freigegeben wurde, basiert auf dieser Version.
Sphinx
Basisdaten
Entwickler Georg Brandl
Erscheinungsjahr März 2008[1]
Aktuelle Version 1.4.8
(1. Oktober 2016)
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 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[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]

Ähnliche Werkzeuge

Einzelnachweise

  1. ↑ raw.githubusercontent.com.
  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. Abgerufen am 6. April 2011. 
  6. ↑ Python Software Foundation News: PSF Funds readthedocs.org. Python Software Foundation, abgerufen am 6. April 2011. 

Literatur

  • Hasecke, Jan Ulrich, und Georg Brandl: Software-Dokumentation mit Sphinx. CreateSpace Independent Publishing Platform, 2014. ISBN 978-1-4974-4868-1
Abgerufen von „https://de.wikipedia.org/w/index.php?title=Sphinx_(Software)&oldid=158842353"