Skip to content
EntityQ1633731· pop 14· linked from 28 articles

Also known as sphinx-doc

Software-Dokumentationswerkzeug

Official website

Sphinx — Sphinx documentation

sphinx-doc.org

Link to the official site · 18,305 chars · not written by Vinony

Source code

Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils. The following command installs Sphinx from the Python Package Index . You will need a working installation of Python and pip.

Excerpt from the source-code README · 2,321 chars · not written by Vinony

Wikidata facts

Official website
sphinx-doc.org
Show 7 more facts
software version identifier
9.1.0
source code repository URL
github.com/sphinx-doc/sphinx
programmed in
Python
copyright license
2-clause BSD License
inception
2008-03-00
readable file format
reStructuredText
Sources (6)

via Wikidata · CC0

Article · Deutsch

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 automatische Generieren von Dokumentation aus Quelltext, das Darstellen mathematischer Notation oder zur Syntax-Hervorhebung. Der erste öffentliche Release wurde am 21. März 2008 freigegeben. Es wurde zur Dokumentation des Python-Projekts entwickelt und wird von diesem auch intensiv eingesetzt. Seit seiner Einführung im Jahr 2008 wurde Sphinx zunehmend auch in anderen wichtigen Python-basierten Projekten wie Bazaar, SQLAlchemy, , Sage, SciPy, Django und eingesetzt, weiterhin wird es zur Dokumentation der Blender-Python-Programmierschnittstelle verwendet. Um die Wartung von Software-Dokumentationen zu vereinfachen, wurde das Read-the-docs-Project gegründet, welches den Prozess des Uploads der aktuellen Dokumentation nach jedem Commit automatisiert. Die Python Software Foundation fördert das Read-the-docs-Projekt.

Abstract from DBpedia / Wikipedia · CC BY-SA