Grundlagen
Benutzerhandbuch
sphinx.ext.apidoc – Generieren von API-Dokumentation aus Python-Paketensphinx.ext.autodoc – Einbinden von Dokumentation aus Docstringssphinx.ext.autosectionlabel – Ermöglicht das Referenzieren von Abschnitten anhand ihres Titelssphinx.ext.autosummary – Generieren von Autodoc-Zusammenfassungensphinx.ext.coverage – Sammeln von Doc-Coverage-Statistikensphinx.ext.doctest – Testen von Snippets in der Dokumentationsphinx.ext.duration – Messen von Dauern der Sphinx-Verarbeitungsphinx.ext.extlinks – Markup zum Kürzen externer Linkssphinx.ext.githubpages – Veröffentlichen von HTML-Dokumenten auf GitHub Pagessphinx.ext.graphviz – Hinzufügen von Graphviz-Graphensphinx.ext.ifconfig – Einbinden von Inhalten basierend auf der Konfigurationsphinx.ext.imgconverter – Ein Referenz-Bildkonverter mit Imagemagicksphinx.ext.inheritance_diagram – Einbinden von Vererbungsgraphensphinx.ext.intersphinx – Verknüpfung zu Dokumentationen anderer Projektesphinx.ext.linkcode – Hinzufügen externer Links zum Quellcodesphinx.ext.napoleon – Unterstützung für Docstrings im NumPy- und Google-Stilsphinx.ext.todo – Unterstützung für Todo-Elementesphinx.ext.viewcode – Hinzufügen von Links zu hervorgehobenem QuellcodeCommunity
Referenz
sphinx.ext.apidoc – Generieren von API-Dokumentation aus Python-Paketensphinx.ext.autodoc – Einbinden von Dokumentation aus Docstringssphinx.ext.autosectionlabel – Ermöglicht das Referenzieren von Abschnitten anhand ihres Titelssphinx.ext.autosummary – Generieren von Autodoc-Zusammenfassungensphinx.ext.coverage – Sammeln von Doc-Coverage-Statistikensphinx.ext.doctest – Testen von Snippets in der Dokumentationsphinx.ext.duration – Messen von Dauern der Sphinx-Verarbeitungsphinx.ext.extlinks – Markup zum Kürzen externer Linkssphinx.ext.githubpages – Veröffentlichen von HTML-Dokumenten auf GitHub Pagessphinx.ext.graphviz – Hinzufügen von Graphviz-Graphensphinx.ext.ifconfig – Einbinden von Inhalten basierend auf der Konfigurationsphinx.ext.imgconverter – Ein Referenz-Bildkonverter mit Imagemagicksphinx.ext.inheritance_diagram – Einbinden von Vererbungsgraphensphinx.ext.intersphinx – Verknüpfung zu Dokumentationen anderer Projektesphinx.ext.linkcode – Hinzufügen externer Links zum Quellcodesphinx.ext.napoleon – Unterstützung für Docstrings im NumPy- und Google-Stilsphinx.ext.todo – Unterstützung für Todo-Elementesphinx.ext.viewcode – Hinzufügen von Links zu hervorgehobenem Quellcodesphinx.ext.githubpages – Veröffentlichen von HTML-Dokumenten auf GitHub Pages¶Hinzugefügt in Version 1.4.
Geändert in Version 2.0: Unterstützung für CNAME-Datei
Diese Erweiterung erstellt eine .nojekyll-Datei im generierten HTML-Verzeichnis, um das Dokument auf GitHub Pages zu veröffentlichen.
Sie erstellt auch eine CNAME-Datei für benutzerdefinierte Domains, wenn html_baseurl gesetzt ist.