Erweiterungen#
Siehe auch
Eingebaute Erweiterungen#
- sphinx.ext.autodoc
bindet Dokumentationen aus Docstrings ein.
- sphinx.ext.autosummary
erzeugt Zusammenfassungen von Funktionen, Methoden und Attributen aus Docstrings.
- sphinx.ext.autosectionlabel
referenziert Abschnitte mit Hilfe des Titels.
- sphinx.ext.graphviz
rendert Graphviz Graphen.
- sphinx.ext.ifconfig
schließt Inhalte nur unter bestimmten Bedingungen ein.
- sphinx.ext.intersphinx
ermöglicht das Einbinden anderer Projektdokumentationen.
- sphinx.ext.mathjax
Rendertmathematische Formeln über JavaScript.
- sphinx.ext.napoleon
unterstützt NumPy und Google Style Docstrings.
- sphinx.ext.todo
unterstützt ToDo-Elemente.
- sphinx.ext.viewcode
fügt Links auf den Quellcode der Sphinx-Dokumentation hinzu.
Siehe auch
Erweiterungen von Drittanbietern#
- nbsphinx
Jupyter Notebooks in Sphinx
- jupyter-sphinx
ermöglicht das Rendern von interaktiven Jupyter-Widgets in Sphinx.
- Breathe
ReStructuredText and Sphinx bridge to Doxygen
- numpydoc
NumPy Sphinx-Erweiterung.
- Releases
schreibt eine Changelog-Datei.
- sphinxcontrib-napoleon
Präprozessor zum Parsen von NumPy- und Google-Style Docstrings.
- sphinx-autodoc-annotation
verwendet Python3-Annotations in Sphinx docstrings
- Sphinx-autodoc-typehints
Unterstützung von Typ-Hints für die Sphinx-Autodoc-Erweiterung.
- sphinx-git
git-Changelog für Sphinx.
- Sphinx Gitstamp Generator Extension
fügt git Zeitstempel im Kontext ein
- sphinx-intl
Sphinx-Erweiterung für Übersetzungen.
- sphinx-autobuild
überwacht ein Sphinx-Repository und erstellt neue Dokumentation, sobald Änderungen vorgenommen werden.
- Sphinx-Needs
erlaubt die Definition, Verlinkung und Filterung von need-Objekten, also z.B. Anforderungen und Testfälle
- Sphinx-pyreverse
erstellt ein UML-Diagramm von Python-Modulen
- sphinx-jsonschema
zeigt ein JSON Schema in der Sphinx-Dokumentation
- Sphinxcontrib-mermaid
ermöglicht euch, Mermaid-Grafiken in Ihre Dokumente einzubetten.
- Sphinx Sitemap Generator Extension
generiert multiversion- und multilanguage sitemaps für die HTML-Version
- Sphinx Lint
basiert auf rstlint.py aus CPython.
- sphinx-toolbox
Werkzeugkasten für Sphinx mit vielen nützlichen Werkzeugen.
Siehe auch
- sphinx-contrib
A repository of Sphinx extensions maintained by their respective authors.
- sphinx-extensions
Curated site with Sphinx extensions with live examples and their configuration.
Eigene Erweiterungen#
Lokale Erweiterungen in einem Projekt sollten relativ zur Dokumentation
angegeben werden. Der entsprechende Pfad wird in der Sphinx-Konfigurationsdatei
docs/conf.py
angegeben. Wenn sich eure Erweiterung im Verzeichnis exts
in der Datei foo.py
befindet, dann sollte die conf.py
-Datei wie folgt
aussehen:
import sys
import os
sys.path.insert(0, os.path.abspath('exts'))
extensions = [
'foo',
...
]
Siehe auch