imported>Trustable: +Kategorie:Static site generator

2025-05-15T14:51:14Z

Neue Seite

{{Infobox Software
| Name=
| Logo= 
| Kategorie= [[Software-Dokumentationswerkzeug]]
| Hersteller= Georg Brandl
| AktuelleVersion= 
| AktuelleVersionFreigabeDatum= 
| Betriebssystem= [[plattformübergreifend]]
| Programmiersprache= [[Python (Programmiersprache)|Python]]
| Lizenz= BSD
| Website= [http://sphinx-doc.org/ sphinx-doc.org]
}}

'''Sphinx''' ist ein [[Software-Dokumentationswerkzeug]], welches [[reStructuredText]] in [[HTML]]-Seiten sowie viele weitere Formate wie [[PDF]], [[EPUB]] und [[Manpage]]s 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<ref>{{Internetquelle |url=http://pythonic.pocoo.org/2008/3/21/sphinx-is-released |titel=Sphinx is released! » And now for something completely Pythonic… |autor=Georg Brandl |zugriff=2011-04-03 |archiv-url=https://web.archive.org/web/20120322064904/http://pythonic.pocoo.org/2008/3/21/sphinx-is-released |archiv-datum=2012-03-22 |archiv-bot=2023-01-12 20:24:40 InternetArchiveBot }}</ref> freigegeben. Es wurde zur Dokumentation des [[Python (Programmiersprache)|Python]]-Projekts entwickelt und wird von diesem auch intensiv eingesetzt.<ref>{{Internetquelle |url=https://docs.python.org/about.html |titel=About these documents – Python v2.7.1 documentation |hrsg=Python Software Foundation |zugriff=2011-04-03}}</ref>

Seit seiner Einführung im Jahr 2008 wurde Sphinx zunehmend auch in anderen wichtigen Python-basierten Projekten wie [[Bazaar]], [[SQLAlchemy]], [[MayaVi]], [[SageMath|Sage]], [[SciPy]], [[Django (Framework)|Django]] und [[Pylons]] eingesetzt, weiterhin wird es zur Dokumentation der [[Blender (Software)|Blender]]-Python-Programmierschnittstelle verwendet.<ref>{{Internetquelle |url=http://wiki.blender.org/index.php/Dev:2.5/Py/API/Generating_API_Reference |titel=Dev:2.5/Py/API/Generating API Reference – BlenderWiki! |hrsg=Blender Foundation |zugriff=2011-04-06 |offline=ja |archiv-bot=2024-05-13 13:34:17 InternetArchiveBot |archiv-url=https://web.archive.org/web/20110223095444/http://wiki.blender.org/index.php/Dev:2.5/Py/API/Generating_API_Reference |archiv-datum=2011-02-23 }}</ref> Um die Wartung von Software-Dokumentationen zu vereinfachen, wurde das ''Read-the-docs''-Project gegründet,<ref>{{Internetquelle |url=https://ericholscher.com/blog/2010/aug/16/announcing-read-docs/ |titel=Announcing Read The Docs |autor=Eric Holscher |zugriff=2011-04-06 |datum=2010-08-16}}</ref> welches den Prozess des Uploads der aktuellen Dokumentation nach jedem Commit automatisiert. Die [[Python Software Foundation]] fördert das Read-the-docs-Projekt.<ref>{{Internetquelle |url=https://pyfound.blogspot.com/2011/03/psf-funds-readthedocsorg.html |titel=PSF Funds readthedocs.org |hrsg=Python Software Foundation |zugriff=2011-04-06 |datum=2011-03-09}}</ref>

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

== Weblinks ==
* [https://www.sphinx-doc.org/ Offizielle Website]
* [https://www.sphinx-doc.org/en/master/examples.html ''A list of projects using Sphinx''] (englisch)
* [https://docs.python.org/ ''Python Documentation''] (mit Sphinx generiert, englisch)

== Einzelnachweise ==
<references />

[[Kategorie:Freies Programmierwerkzeug]]
[[Kategorie:Python (Programmiersprache)]]
[[Kategorie:Static site generator]]

Sphinx (Software) - Versionsgeschichte

imported>Trustable: +Kategorie:Static site generator