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
rendert mathematische 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¶
- Breathe
ReStructuredText und Sphinx-Brücke zu Doxygen.
- sphinx-autobuild
überwacht ein Sphinx-Repository und erstellt neue Dokumentation, sobald Änderungen vorgenommen werden.
- sphinx-autodoc-typehints
Unterstützung von Type-Hints für die Sphinx-Autodoc-Erweiterung.
- nbsphinx
Jupyter Notebooks in Sphinx
- sphinxcontrib-mermaid
ermöglicht euch, Mermaid-Grafiken in eure Dokumente einzubetten.
- numpydoc
NumPy Sphinx-Erweiterung.
- Sphinx-Needs
erlaubt die Definition, Verlinkung und Filterung von need-Objekten, also z.B. von Anforderungen und Testfälle
- jupyter-sphinx
ermöglicht das Rendern von interaktiven Jupyter-Widgets in Sphinx.
- Releases
schreibt eine
CHANGELOG-Datei.- Sphinx Lint
basiert auf rstlint.py aus CPython.
- sphinx-intl
Sphinx-Erweiterung für Übersetzungen.
- sphinx-jsonschema
zeigt ein JSON Schema in der Sphinx-Dokumentation.
- sphinx-toolbox
Werkzeugkasten für Sphinx mit vielen nützlichen Werkzeugen.
- Sphinx Sitemap Generator Extension
generiert multiversion- und multilanguage-sitemaps für die HTML-Version
- sphinx-issues
erstellt Links zu GitHub or GitLab Issues, Pull-Requests und Benutzerprofilen.
- Sphinx-pyreverse
erstellt ein UML-Diagramm von Python-Modulen.
- Sphinx-Test-Reports
zeigt Testergebnisse innerhalb von Sphinx-Dokumentationen an.
- Sphinx Gitstamp Generator Extension
fügt Git-Zeitstempel im Kontext ein, z.B. in einem Jinja-Template:
{%- if gitstamp %} Diese Seite wurde zuletzt aktualisiert am {{ gitstamp }}. {%- endif %}
- sphinx-changelog
erleichtert das Rendern von
CHANGELOG-Dateien.
Siehe auch
- sphinx-contrib
Ein Repository mit Sphinx-Erweiterungen, die von ihren jeweiligen Autoren gepflegt werden.
- sphinx-extensions
Kuratierte Website mit Sphinx-Erweiterungen mit Live-Beispielen und deren Konfiguration.
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