Sphinx Dokumentationsinhalt

Grundlagen

• Sphinx installieren
  • PyPI-Paket
  • Conda-Paket
  • Betriebssystemspezifischer Paketmanager
    • Linux
    • macOS
    • Windows
  • Docker
  • Installation der neuesten Entwicklungsversion
  • Installation aus dem Quellcode
• Erste Schritte
  • Einrichtung der Dokumentationsquellen
  • Dokumentationsstruktur definieren
  • Inhalt hinzufügen
  • Build ausführen
  • Objekte dokumentieren
    • enumerate()
  • Grundlegende Konfiguration
  • Autodoc
  • Intersphinx
  • Weitere zu behandelnde Themen
• Erstes Projekt erstellen
  • Erste Schritte
    • Einrichtung Ihres Projekts und Ihrer Entwicklungsumgebung
    • Erstellen des Dokumentationslayouts
  • Erste Schritte zur Dokumentation Ihres Projekts mit Sphinx
    • Erstellen Ihrer HTML-Dokumentation
    • Erstellen Ihrer Dokumentation in anderen Formaten
  • Weitere Sphinx-Anpassungen
    • Aktivieren einer integrierten Erweiterung
    • Verwenden eines Drittanbieter-HTML-Themes
  • Narrative Dokumentation in Sphinx
    • Strukturieren Ihrer Dokumentation über mehrere Seiten hinweg
    • Hinzufügen von Querverweisen
  • Code in Sphinx beschreiben
    • Python
    • Andere Sprachen (C, C++, andere)
  • Automatische Dokumentationsgenerierung aus Code
    • Signaturen und Docstrings mit Autodoc wiederverwenden
    • Umfassende API-Referenzen generieren
  • Anhang: Online-Bereitstellung eines Sphinx-Projekts
    • Sphinx-freundliche Deployment-Optionen
    • Umarmen der „Docs as Code“-Philosophie
    • Veröffentlichen Ihrer Dokumentationsquellen
    • Veröffentlichen Ihrer HTML-Dokumentation
  • Wohin als Nächstes

Benutzerhandbuch

• Sphinx verwenden
  • reStructuredText
    • reStructuredText-Primer
    • Rollen
    • Direktiven
    • Feldlisten
    • VERSCHOBEN: Domänen
  • Markdown
    • Konfiguration
  • Querverweise
    • Syntax
    • Objekte referenzieren
    • Beliebige Speicherorte referenzieren
    • Dokumente referenzieren
    • Herunterladbare Dateien referenzieren
    • Abbildungen nach Abbildungsnummer referenzieren
    • Sonstige interessante Elemente referenzieren
    • Alles referenzieren
  • Konfiguration
    • Projekt-Tags
    • Projektinformationen
    • Allgemeine Konfiguration
    • Builder-Optionen
    • Domain-Optionen
    • Erweiterungsoptionen
    • Beispiel-Konfigurationsdatei
  • Builder
    • StandaloneHTMLBuilder
    • DirectoryHTMLBuilder
    • SingleFileHTMLBuilder
    • HTMLHelpBuilder
    • QtHelpBuilder
    • AppleHelpBuilder
    • DevhelpBuilder
    • Epub3Builder
    • LaTeXBuilder
    • TextBuilder
    • ManualPageBuilder
    • TexinfoBuilder
    • SerializingHTMLBuilder
    • PickleHTMLBuilder
    • JSONHTMLBuilder
    • MessageCatalogBuilder
    • ChangesBuilder
    • DummyBuilder
    • CheckExternalLinksBuilder
    • XMLBuilder
    • PseudoXMLBuilder
    • Details zu Serialisierungs-Buildern
  • Domänen
    • Integrierte Domänen
    • Domänen von Drittanbietern
    • Grundlegende Markup-Sprache
  • Erweiterungen
    • Integrierte Erweiterungen
    • Drittanbieter-Erweiterungen
  • HTML-Theming
    • Builder
    • Themes
  • Internationalisierung
    • Details zur Internationalisierung von Sphinx
    • Übersetzen mit sphinx-intl
    • Verwendung des Transifex-Dienstes für Teamübersetzungen
    • Verwendung des Weblate-Dienstes für Teamübersetzungen
    • Beitrag zur Übersetzung der Sphinx-Referenz
    • Übersetzungsfortschritt und Statistiken
  • Sphinx Web Support
    • Web Support Schnellstart
    • Die Klasse WebSupport
    • Suchadapter
    • Speicher-Backends
• Sphinx erweitern
  • Tutorials
    • Syntax mit Rollen und Direktiven erweitern
    • Erweiterung des Build-Prozesses
    • Hinzufügen einer Referenzdomäne
    • Entwicklung von Autodoc-Erweiterungen
  • Anleitungen
    • Abhängigkeit von einer anderen Erweiterung
    • Konfiguration von Buildern
  • HTML-Theme-Entwicklung
    • Erstellung von Themes
    • Verteilen Sie Ihr Theme als Python-Paket
    • Styling mit CSS
    • Templating
• Sphinx API
  • Wichtige Objekte
  • Build-Phasen
  • Erweiterungsmetadaten
  • APIs zum Schreiben von Erweiterungen
    • Anwendungs-API
    • API für Ereignis-Callbacks
    • Projekt-API
    • API der Build-Umgebung
    • Builder-API
    • API des Ereignis-Managers
    • API des Umgebungs-Kollektors
    • Docutils-Markup-API
    • Domain-API
    • Parser-API
    • Von Sphinx hinzugefügte Doctree-Knotenklassen
    • Logging-API
    • i18n-API
    • Dienstprogramme
    • Test-API
    • Veraltete APIs
• LaTeX-Anpassung
  • Die Konfigurationseinstellung latex_elements
  • Die Konfigurationseinstellung sphinxsetup
  • Zusätzliche CSS-ähnliche 'sphinxsetup'-Schlüssel
  • LaTeX-Makros und Umgebungen
    • Makros
    • Der Befehl \sphinxbox
    • Umgebungen
    • Verschiedenes

Community

• Unterstützung erhalten
• Zu Sphinx beitragen
  • Zu Sphinx beitragen
    • Hilfe erhalten
    • Fehlerberichte und Funktionsanfragen
    • Code beitragen
    • Dokumentation beitragen
    • Übersetzungen
    • Debugging-Tipps
    • Generierte Dateien aktualisieren
  • Der Release-Prozess von Sphinx
    • Versionierung
    • Eine Funktion als veraltet markieren
    • Richtlinie für veraltete Funktionen
    • Richtlinie für Python-Versionsunterstützung
    • Freigabeverfahren
  • Organisation des Sphinx-Projekts
    • Kernentwickler
    • Andere Mitwirkende
  • Verhaltenskodex von Sphinx
• Sphinx FAQ
  • Wie mache ich…
  • Sphinx verwenden mit…
  • Sphinx vs. Docutils
  • Epub-Informationen
  • Texinfo-Informationen
    • Links anzeigen
    • Hinweise
• Sphinx Autoren
  • Betreuer
  • Mitarbeiter
  • Ehemalige Betreuer

Referenz

• Kommandozeilenwerkzeuge
  • Kernanwendungen
    • sphinx-quickstart
    • sphinx-build
  • Zusätzliche Anwendungen
    • sphinx-apidoc
    • sphinx-autogen
• Konfiguration
  • Projekt-Tags
  • Projektinformationen
    • projekt
    • autor
    • copyright
    • projekt_copyright
    • version
    • release
  • Allgemeine Konfiguration
    • needs_sphinx
    • extensions
    • needs_extensions
    • manpages_url
    • today
    • today_fmt
    • Optionen für die Abbildungsnummerierung
    • Optionen für die Hervorhebung
    • Optionen für HTTP-Anfragen
    • Optionen für Internationalisierung
    • Optionen für Markup
    • Optionen für Mathematik
    • Optionen für den nitpicky-Modus
    • Optionen für ObjektSignaturen
    • Optionen für Quelldateien
    • Optionen für intelligente Anführungszeichen
    • Optionen für Templating
    • Optionen zur Warnungskontrolle
  • Builder-Optionen
    • Optionen für HTML-Ausgabe
    • Optionen für Single-HTML-Ausgabe
    • Optionen für HTML-Hilfe-Ausgabe
    • Optionen für Apple-Hilfe-Ausgabe
    • Optionen für EPUB-Ausgabe
    • Optionen für LaTeX-Ausgabe
    • Optionen für Textausgabe
    • Optionen für Handbuchseiten-Ausgabe
    • Optionen für Texinfo-Ausgabe
    • Optionen für QtHelp-Ausgabe
    • Optionen für XML-Ausgabe
    • Optionen für den linkcheck Builder
  • Domain-Optionen
    • Optionen für die C-Domäne
    • Optionen für die C++-Domäne
    • Optionen für die Javascript-Domäne
    • Optionen für die Python-Domäne
  • Erweiterungsoptionen
  • Beispiel-Konfigurationsdatei
• Erweiterungen
  • Integrierte Erweiterungen
    • sphinx.ext.apidoc – Generieren von API-Dokumentation aus Python-Paketen
    • sphinx.ext.autodoc – Einbinden von Dokumentation aus Docstrings
    • sphinx.ext.autosectionlabel – Ermöglicht das Referenzieren von Abschnitten anhand ihres Titels
    • sphinx.ext.autosummary – Generieren von Autodoc-Zusammenfassungen
    • sphinx.ext.coverage – Sammeln von Doc-Coverage-Statistiken
    • sphinx.ext.doctest – Testen von Snippets in der Dokumentation
    • sphinx.ext.duration – Messen von Dauern der Sphinx-Verarbeitung
    • sphinx.ext.extlinks – Markup zum Kürzen externer Links
    • sphinx.ext.githubpages – Veröffentlichen von HTML-Dokumenten auf GitHub Pages
    • sphinx.ext.graphviz – Hinzufügen von Graphviz-Graphen
    • sphinx.ext.ifconfig – Einbinden von Inhalten basierend auf der Konfiguration
    • sphinx.ext.imgconverter – Ein Referenz-Bildkonverter mit Imagemagick
    • sphinx.ext.inheritance_diagram – Einbinden von Vererbungsgraphen
    • sphinx.ext.intersphinx – Verknüpfung zu Dokumentationen anderer Projekte
    • sphinx.ext.linkcode – Hinzufügen externer Links zum Quellcode
    • Mathematikunterstützung für HTML-Ausgaben in Sphinx
    • sphinx.ext.napoleon – Unterstützung für Docstrings im NumPy- und Google-Stil
    • sphinx.ext.todo – Unterstützung für Todo-Elemente
    • sphinx.ext.viewcode – Hinzufügen von Links zu hervorgehobenem Quellcode
  • Drittanbieter-Erweiterungen
    • Wo eigene Erweiterungen platzieren?
• reStructuredText
  • reStructuredText-Primer
    • Absätze
    • Inline-Auszeichnung
    • Listen und Zitat-ähnliche Blöcke
    • Literale Blöcke
    • Doctest-Blöcke
    • Tabellen
    • Hyperlinks
    • Abschnitte
    • Feldlisten
    • Rollen
    • Explizite Auszeichnung
    • Direktiven
    • Bilder
    • Fußnoten
    • Zitate
    • Ersetzungen
    • Kommentare
    • HTML-Metadaten
    • Quellcodierung
    • Fallstricke
  • Rollen
    • Querverweise
    • Inline-Code-Hervorhebung
    • Mathematik
    • Andere semantische Auszeichnung
    • Ersetzungen
  • Direktiven
    • Inhaltsverzeichnis
    • Absatzebenen-Auszeichnung
    • Codebeispiele anzeigen
    • Glossar
    • Meta-Informations-Auszeichnung
    • Indexgenerierende Auszeichnung
    • Inhalte basierend auf Tags einfügen
    • Tabellen
    • Mathematik
    • Grammatikproduktionsanzeigen
  • Feldlisten
    • Dateiweite Metadaten
    • Spezielle Metadatenfelder
  • VERSCHOBEN: Domänen
    • VERSCHOBEN: Grundlegendes Markup
    • VERSCHOBEN: Python-Domäne
    • VERSCHOBEN: C-Domäne
    • VERSCHOBEN: C++-Domäne
    • VERSCHOBEN: Standard-Domäne
    • VERSCHOBEN: JavaScript-Domäne
    • VERSCHOBEN: reStructuredText-Domäne
    • VERSCHOBEN: Mathematik-Domäne
    • VERSCHOBEN: Weitere Domänen
• Glossar
• Änderungsprotokoll
  • Release 9.0.1 (in Entwicklung)
    • Behobene Fehler
  • Release 9.0.0 (veröffentlicht am 30. November 2025)
    • Abhängigkeiten
    • Inkompatible Änderungen
    • Veraltet
    • Hinzugefügte Funktionen
    • Behobene Fehler
    • Tests
  • Vorherige Releases
    • Sphinx 8.2
    • Sphinx 8.1
    • Sphinx 8.0
    • Sphinx 7.4
    • Sphinx 7.3
    • Sphinx 7.2
    • Sphinx 7.1
    • Sphinx 7.0
    • Sphinx 6.2
    • Sphinx 6.1
    • Sphinx 6.0
    • Sphinx 5.3
    • Sphinx 5.2
    • Sphinx 5.1
    • Sphinx 5.0
    • Sphinx 4.5
    • Sphinx 4.4
    • Sphinx 4.3
    • Sphinx 4.2
    • Sphinx 4.1
    • Sphinx 4.0
    • Sphinx 3.5
    • Sphinx 3.4
    • Sphinx 3.3
    • Sphinx 3.2
    • Sphinx 3.1
    • Sphinx 3.0
    • Sphinx 2.4
    • Sphinx 2.3
    • Sphinx 2.2
    • Sphinx 2.1
    • Sphinx 2.0
    • Sphinx 1.8
    • Sphinx 1.7
    • Sphinx 1.6
    • Sphinx 1.5
    • Sphinx 1.4
    • Sphinx 1.3
    • Sphinx 1.2
    • Sphinx 1.1
    • Sphinx 1.0
    • Sphinx 0.6
    • Sphinx 0.5
    • Sphinx 0.4
    • Sphinx 0.3
    • Sphinx 0.2
    • Sphinx 0.1
• Projekte, die Sphinx verwenden
  • Dokumentation mit dem Alabaster-Theme
  • Dokumentation mit dem Classic-Theme
  • Dokumentation mit dem Sphinx-Doc-Theme
  • Dokumentation mit dem Nature-Theme
  • Dokumentation mit einem anderen integrierten Theme
  • Dokumentation mit Read the Docs Sphinx Theme
  • Dokumentation mit Sphinx Bootstrap Theme
  • Dokumentation mit PyData Sphinx Theme
  • Dokumentation mit dem Furo-Theme
  • Dokumentation mit einem benutzerdefinierten Theme oder integriert in eine Website
  • Homepages und andere Nicht-Dokumentations-Websites
  • Mit Sphinx erstellte Bücher
  • Mit Sphinx erstellte Abschlussarbeiten
  • Projekte, die Sphinx-Funktionalität integrieren