Sphinx¶

Erstellen Sie mühelos 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 Notationen und mehr.

🔗 Leistungsstarke Querverweise

Erstellen Sie Querverweise innerhalb Ihres Projekts und sogar über verschiedene Projekte hinweg. Fügen Sie Referenzen zu Abschnitten, Abbildungen, Tabellen, Zitaten, Glossaren, Codeobjekten und mehr hinzu.

📚 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 optisch ansprechende Dokumentationen mit einer großen Auswahl an integrierten und Drittanbieter-Themes und der Möglichkeit, neue Themes anzupassen oder zu erstellen.

🔌 Vollständig erweiterbar

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

🛠️ Automatische API-Dokumentation

Generieren Sie API-Dokumentation 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 mehrere Sprachen hinzu, um ein globales Publikum zu erreichen.

🌟 Aktive Community und Unterstützung

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

Verwendet von

Python¶

Linux Kernel¶

Project Jupyter¶

Sehen Sie unten, wie Sie die Dokumentation von Sphinx navigieren.

Siehe auch

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

Erste Schritte¶

Diese Abschnitte behandeln die Grundlagen des Einstiegs in Sphinx, einschließlich der Erstellung und Generierung 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 Wissen über Sphinx voraus. Wenn Sie neu bei Sphinx sind, empfehlen wir Ihnen, mit Erste Schritte zu beginnen.

Community-Handbuch¶

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

Sehen Sie sich das Handbuch für Sphinx-Mitarbeiter an, 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 zugegriffen werden kann. Wenn Sie anwendungsfallorientierte Dokumentation wünschen, siehe Erste Schritte oder Benutzerhandbuch.

Referenz