Sphinx ist ein Werkzeug, das es einfach, intelligent und schön Dokumentation zu Python-Projekte (oder andere Dokumente, die aus mehreren Quellen reStructuredText), von Georg Brandl geschrieben schaffen macht. Das Projekt wurde ursprünglich geschaffen, um die neue Python-Dokumentation zu übersetzen, aber hat jetzt wurde in der Hoffnung, dass es nützlich für viele andere Projekte sein gesäubert.
Sphinx verwendet reStructuredText als Markup-Sprache, und von der Gewalt und Geradlinigkeit der reStructuredText und ihre Analyse und die Übersetzung Suite, die Docutils viele seiner Stärken kommen.
Obwohl es immer noch ständig weiterentwickelt wird, sind die folgenden Funktionen bereits vorhanden ist, funktionieren und kann "in Aktion" zu sehen ist in der Python-Dokumentation:
& Nbsp; * Ausgabeformate: HTML (einschließlich Windows HTML-Hilfe) und LaTeX, für druckbare PDF-Version
& Nbsp; * Umfangreiche Querverweise: semantisches Markup und automatische Links für Funktionen, Klassen, Glossarbegriffe und ähnliche Stücke von Informationen
& Nbsp; * Hierarchische Struktur: einfache Definition eines Dokuments Baum, mit automatischen Links zu Geschwistern, Eltern und Kinder
& Nbsp; * Automatische Indizes: Generalindex als auch ein Modul-Übersicht
& Nbsp; * Code Umgang: automatische Hervorhebung mit dem Textmarker Pygments
& Nbsp; * Verschiedene Erweiterungen zur Verfügung stehen, beispielsweise . zur automatischen Prüfung von Snippets und Einbeziehung der entsprechend formatierte Docstrings
Anforderungen :
- Python
Kommentare nicht gefunden