Sphinx¶

Erstellen Sie mit Leichtigkeit intelligente und schöne Dokumentationen

📝 Rich Text Formatierung

Schreiben Sie in reStructuredText oder MyST Markdown, um hochgradig strukturierte technische Dokumente zu erstellen, einschließlich Tabellen, hervorgehobener Codeblöcke, mathematischer Notation und mehr.

🔗 Leistungsstarke Querverweise

Erstellen Sie Querverweise innerhalb Ihres Projekts und sogar über verschiedene Projekte hinweg. Fügen Sie Verweise auf Abschnitte, Abbildungen, Tabellen, Zitate, Glossare, Codeobjekte und mehr ein.

📚 Vielseitige Dokumentationsformate

Generieren Sie Dokumentationen in den bevorzugten Formaten Ihres Publikums, einschließlich HTML, LaTeX (für PDF), ePub, Texinfo, und mehr.

🎨 Umfangreiche Theme-Unterstützung

Erstellen Sie visuell ansprechende Dokumentationen mit einer großen Auswahl an integrierten und Drittanbieter-HTML-Themes und der Möglichkeit, Themes anzupassen oder neue Themes zu erstellen.

🔌 Vollständig erweiterbar

Fügen Sie benutzerdefinierte Funktionalität über robuste Erweiterungsmechanismen mit zahlreichen integrierten und Drittanbieter-Erweiterungen für Aufgaben wie die Erstellung von Diagrammen, das Testen von Code und mehr hinzu.

🛠️ Automatische API-Dokumentation

Generieren Sie API-Dokumentationen für Python, C++ und andere Software-Domänen, manuell oder automatisch aus Docstrings, um sicherzustellen, dass Ihre Code-Dokumentation mit minimalem Aufwand auf dem neuesten Stand bleibt.

🌍 Internationalisierung (i18n)

Fügen Sie Dokumentations-Übersetzungen in mehreren Sprachen hinzu, um ein globales Publikum zu erreichen.

🌟 Aktive Community und Support

Profitieren Sie von einer aktiven Community mit zahlreichen Ressourcen, Tutorials, Foren und Beispielen.

Wie verwendet von

Python¶

Linux-Kernel¶

Project Jupyter¶

Sehen Sie unten, wie Sie die Sphinx-Dokumentation navigieren können.

Siehe auch

Das Inhaltsverzeichnis der Sphinx-Dokumentation enthält eine vollständige Liste der Seiten dieser Website.

Erste Schritte¶

Diese Abschnitte behandeln die Grundlagen der ersten Schritte mit Sphinx, einschließlich der Erstellung und des Builds Ihrer eigenen Dokumentation von Grund auf.

Benutzerhandbuch¶

Diese Abschnitte behandeln verschiedene Themen zur Verwendung und Erweiterung von Sphinx für verschiedene Anwendungsfälle. Sie sind eine umfassende Anleitung zur Verwendung von Sphinx in vielen Kontexten und setzen mehr Kenntnisse über Sphinx voraus. Wenn Sie neu bei Sphinx sind, empfehlen wir Ihnen, mit Erste Schritte zu beginnen.

Community-Leitfaden¶

Sphinx wird von der Community unterstützt und freut sich über Beiträge von jedem. Die folgenden Abschnitte sollen Ihnen helfen, mit der Sphinx-Community in Kontakt zu treten und Beiträge zu leisten.

Siehe den Beitragsleitfaden für Sphinx-Mitarbeiter, wenn Sie zum Projekt beitragen möchten.

Community

Referenzhandbuch¶

Die Referenzdokumentation ist vollständiger und programmatischer Natur; sie ist eine Sammlung von Informationen, auf die schnell verwiesen werden kann. Wenn Sie anwendungsfallgesteuerte Dokumentation wünschen, siehe Erste Schritte oder Benutzerhandbuch.

Referenz