Extensions

Built-in Extensions

sphinx.ext.autodoc

Dokumentation aus Docstrings integrieren

sphinx.ext.autosummary

generiert Zusammenfassungen von Funktionen, Methoden und Attributen aus Docstrings

sphinx.ext.autosectionlabel

referenziert Abchnitt unter Verwendung des Titels

sphinx.ext.graphviz

Rendering von Graphviz-Graphen

sphinx.ext.ifconfig

schließt Inhalte nur unter bestimmten Bedingungen ein

sphinx.ext.intersphinx

erlaubt die Verlinkung von anderen Projekt-Dokumentationen

sphinx.ext.mathjax

Rendering via JavaScript

sphinx.ext.napoleon

Support für NumPy- und Google-Style Docstrings

sphinx.ext.todo

Unterstützung für ToDo-Items

sphinx.ext.viewcode

fügt Links zum Quellcode der Sphinx-Dokumentation hinzu

Siehe auch

Einen vollständigen Überblick erhaltet ihr unter Sphinx Extensions

Third-party Extensions

nbsphinx

Jupyter Notebooks in Sphinx

jupyter-sphinx

erlaubt das Rendering von Jupyter interactive widgets in Sphinx, s.a.

Embedding Widgets in the Sphinx HTML Documentation

numpydoc

NumPy’s Sphinx-Extension

Releases

schreibt eine Changelog-Datei

sphinxcontrib-napoleon

Napoleon ist ein Pre-Processor zum Parsen von NumPy- und Google-Style Docstrings

Sphinx-autodoc-typehints

Type hints-Support für die Sphinx autodoc-Extension

sphinx-git

git-Changelog for Sphinx

sphinx-intl

Sphinx-Erweiterung für Übersetzungen

sphinx-autobuild

überwacht ein Sphinx-Repository und erstellt eine neue Dokumentation sobald Änderungen gemacht wurden

Sphinxcontrib-mermaid

erlaubt, Mermaid- Grafiken in eure Dokumente einzubetten.

Eigene Extensions

Lokale Erweiterungen in einem Projekt sollten relativ zur Dokumentation angegeben werden. Hierfür wird in der Sphinx-Konfigurationsdatei docs/conf.py der entsprechende Pfad angegeben. Wenn eure Erweiterung im Verzeichnis exts in der Datei foo.py liegt, dann wird in der conf.py folgendes eingetragen:

import sys
import os
sys.path.insert(0, os.path.abspath('exts'))

extensions = [
'foo',
...
]