Sphinx

Wenn zum ersten Mal erstellt, ist es Hauptzweck war, eine Dokumentationsgenerator für Python der eigenen Code zu dienen.
Seitdem hat sich das Projekt Kultstatus bei der Entwicklung weltweit erreicht hat, wobei einer der erwähnten Einflüsse in den meisten automatischen Dokumentation Generatoren um, unabhängig von der Sprache.
Heute, neben nur Python, Sphinx kann auch mit C und C ++ Code als auch verwendet werden.

Was ist neu in dieser Pressemitteilung:

Als Alias ​​für `` cpp var``:: member``, `` Rolle: als Alias ​​für `` var``:: cav:
• In Convenience-Richtlinien und Rollen, die dem C ++ Domain: Richtlinie `` cpp cpp Mitglied `` und `Rolle any` für Querverweis auf jede C ++ declaraction.
• Die: confval: `source_suffix` Config-Wert kann nun eine Liste mit mehreren Endungen werden
.
• Fügen Sie die Fähigkeit, Quelle Parser nach Quelle mit dem Suffix angeben: confval:. `Source_parsers` Config-Wert
• Eine neue Baumeister, AppleHelpBuilder, wurde hinzugefügt, Apple Help Books baut.

Was ist neu in Version 1.2.3 / 1.3b3:

• für programmatischen Überprüfung der Sphinx Version Hinzugefügt `` sphinx.version_info`` Tupel.

Was ist neu in Version 1.1.3:

• Absturz bei einigen Einstellungen: confval:. `Modindex_common_prefix`
• Die Behandlung von `` und `` -D`` -A`` Optionen auf Python 3.
• Anerkannte und warnen etwa kreis toctrees, anstatt zu rennen in Rekursion Fehler.
• Wiederherstellen Kompatibilität mit docutils Kofferraum.
• Feste Htmlhelp Indexeintrag Links wieder.
• Feste inheritance_diagram Anhebung Attribut Fehler auf builtins.
• Abstürze beim Anlegen Kommentare oder einsame Begriffe in einem Glossar.
• Feste HTML Hilfe Sprache / Encoding-Mapping für alle Sphinx unterstützten Sprachen.

Was ist neu in der Version 1.1:

• Eigenschaften hinzugefügt:
• Added Python 3.x Support.
• New Bauer und Subsystem.
• Inkompatible Änderungen:
• Die: rst: dir: `Vj module` Richtlinie nicht mehr seine` `platform`` Option Wert ausgegeben. (Es war die einzige Sache, dass die Richtlinie tat Ausgang und deshalb ziemlich inkonsistent.)
• entfernt die Unterstützung für alte Abhängigkeit Versionen.
• New Gebietsschema:
• Hinzugefügt Swedish locale.
• Hinzugefügt iranischen locale.
• Hinzugefügt Latvian locale.
• Hinzugefügt Nepali locale.
• Hinzugefügt koreanischen Gebietsschema.
• Hinzugefügt Estonian locale.

Was ist neu in Version 1.0.8:

• Fix Rückverfolgungen für AttributeErrors in Autozusammenfassen-Generation.
• Befestigen Sie die `` abbr`` Rolle, wenn die Abkürzung hat neue Zeilen in es.
• Befestigen Sie die Links zu den Suchergebnissen mit eigenen Objekttypen.
• Fix Zeilennummern in Warnungen über undefinierte Referenzen angegeben.
• Fix C ++ Array Definitionen und Template-Argumente, die nicht geben Namen.
• Lassen Sie Fußnoten in Abschnittsüberschriften in LaTeX-Ausgabe.
• Lassen Sie Stichworte, um über intersphinx verknüpft werden.
• Lassen Sie Unicode-Zeichen in Produktionsliste Token Namen.
• In dummy Besucher für graphviz Knoten für Text und Mensch.
• Fix-Image-Datei Vervielfältigung bug.
• Fix Parsen von Mehrfachsignaturen in C ++ Domäne.
• Ignorieren Emacs Lock-Dateien, wenn Sie Quelldateien.
• Lassen .pyw Erweiterung für importable Module in AutoDoc.
• Verwenden `` $ (MAKE) `` in Quickstart-generierten Makefiles.
• Seitenleiste Suchfeld Breite konsistent in Browsern.
• Fix Abstand zentriert Zahlen in der HTML-Ausgabe.
• Safely kodieren SphinxError Meldungen beim Drucken sie sys.stderr.
• Fix LaTeX Ausgangsfehler mit einem Dokument ohne Abschnitte als ein Link-Ziel.
• Richtig behandeln integrierte Methode Deskriptoren als Methoden in AutoDoc.
• Stopp monkeypatching das Python-Modul TextWrap.
• Viewcode funktioniert nun korrekt mit Quelldateien, die Nicht-ASCII-Codierung haben.
• Respektieren Sie die `` noindex`` flag Option im Vj. Modul-Richtlinien
• Fix IndexErrors wenn auch nicht vorhandenen Linien mit: rst: dir:. `Literalinclude`
• Respect benutzerdefinierte Funktion / Methode Parameter Trennzeichenfolgen.
• Fix JS Unvereinbarkeit mit jQuery & gt;. = 1,5
• Fix Doppelcodierung durchgeführt, wenn das Schreiben Htmlhelp .hhk Dateien.
• Sie nicht Smartypants in geparst-wörtliche Blöcke gelten.
• C ++ Domäne unterstützt nun Array-Definitionen.

Was ist neu in Version 1.0.6:

• Fix Traceback in Python-Domäne für leere Querverweisziele.
• Fix wörtlichen Satzanzeige Themen auf Chrome-Browser.
• Unterstützung Sortieren einer begrenzten Anzahl von Sonderzeichen in den allgemeinen Index und Glossar.
• Versuchen Decodierung `` und `` -D`` -A`` Befehlszeilenargumente mit der locale bevorzugte Codierung.
• Beachten Sie: confval:. `Locale_dirs` bei der Suche nach der JS-Datei Übersetzungen
• In speziellen Code für eine bessere Unterstützung der japanischen Dokumente im LaTeX-Builder.
• Regression von # 77: Wenn es nur einen Parameter mit `` gegeben: param:. `` Markup, die Aufzählung ist nun wieder unterdrückt
• Fix fehlende Absatzumbrüche in LaTeX-Ausgabe in bestimmten Situationen.
• Emit die `` AutoDoc-Prozess-docstring`` Veranstaltung auch für Objekte ohne docstring, so dass sie Inhalte hinzufügen.
• In der LaTeX-Builder, nicht nur wörtliche Blöcke erfordern unterschiedliche Tisch Handhabung, sondern auch etliche andere Liste artig Blockelemente.
• Fix Rückverfolgungen in der Viewcode-Erweiterung für Python-Objekte, die nicht über eine gültige Signatur.
• Fix seltsame Reportings von Zeilennummern für die Warnungen von AutoDoc-Docstrings enthalten, aufgrund der unterschiedlichen Verhalten je nach docutils-Version erzeugt.
• Einige Fixes für die C ++ Domäne.

Was ist neu in Version 1.0.5:

• In docutils von 0,7 für die ausgerichteten Bilder und Figuren benötigt CSS-Stile.
• Im Makefile von LaTeX-Ausgabe erzeugt wird, keine PDF-Dateien auf sauber zu löschen; sie erforderlich sein könnten Bilder.
• Fix LaTeX-Ausgabe für Zeilenblöcke erzeugt.
• Lassen Sie `` als Quelle Dateierweiterung .pyw``.

Was ist neu in Version 1.0.4:

• Öffnen intersphinx Vorräte im Binär-Modus unter Windows seit Version 2 enthält zlib-komprimierte Daten.
• Lassen Sie geben nicht-lokalen URIs für JavaScript-Dateien, wie zB in der jsMath-Erweiterung.
• Fix Traceback, wenn `` intersphinx_mapping`` ist leer.

Was ist neu in Version 1.0.3:

• Fix interne vs. external link Auszeichnung für Links aus einer docutils table-of-contents.
• Befestigen Sie die `` maxdepth`` Option für die `` toctree () `` Vorlage aufrufbar, wenn sie mit `` verwendet Zusammenbruch = True``.
• Fix Absturz Parsen Python Argument Listen mit Klammern in Zeichenfolgenliterale.
• Fix Regression beim Bau von LaTeX-Dokumente mit Zahlen, die keine Untertitel.
• Fix Vererbungspläne für Klassen, die nicht picklable werden.
• Führen separater Hintergrundfarbe für die Seitenleiste Zusammenbruch Taste, so dass es leichter zu sehen.
• Fix kleine Layout Bugs in mehreren integrierten Designs.

Was ist neu in Version 1.0.2:

• Fix Querverweise auf Objekte der Typen eingestellt vom: func:. `~ .Sphinx.add_object_type` API-Funktion
• Fix Umgang mit doc Feldtypen für unterschiedliche Arten Richtlinie.
• Lassen Sie brechen lange Signaturen weiterhin mit spiel entgangen Zeilenumbrüche.
• Fix unerwünschte Styling der C-Domäne Referenzen (wegen einer Namensraum Zusammenstoß mit Pygments Arten).
• Lassen Sie Verweise auf PEPs und RFCs mit ausdrücklicher Anker.
• Fix LaTeX Referenzen auf Zahlen.
• Bei der nicht-exakte Suche, Match nur der gegebenen Art von Objekt.
• Tragen Sie nicht genaue Suche nach Python Referenzziele mit `` .name`` für Module zu.
• Fix Absturz beim Duplizieren eines Parameters in einem Info-Feld-Liste.
• Fix die Einstellung der Standardrolle an einem von der `` oldcmarkup`` Erweiterung vorgesehen.
• Fix Absturz beim json-py installiert ist, die eine `` json`` Modul bietet aber ist unvereinbar simplejson.
• Fix Handhabung der Zielbenennung in intersphinx.
• Fix Entfernen von ``! `` Für alle Querverweis Rollen.

Was ist neu in Version 1.0.1:

• Fix erzeugten Zielnamen für die Erholung Domain-Objekte; sie sind nicht im gleichen Namensraum.
• In Bengali Sprache.
• Fix einen Fehler beim Verarbeiten JavaScript Objektnamen.
• Fix Gebäude mit SingleHTMLBuilder, wenn es keine toctree.
• Fix Anzeigenamen für Objekte, die von intersphinx mit expliziten Ziele geknüpft.
• Fix Gebäude mit der JSON-Builder.
• Fix hyperrefs in Objektbeschreibungen für LaTeX.

Was ist neu in der Version 1.0:

• Allgemein:
• Es wurde ein "pingelig" Modus, der Warnungen für alle fehlende Verweise emittiert. Option:: `-n` Befehlszeilenoption oder: confval: Es wird von der aktiviert wird.` Nitpicky` Config-Wert
• Hinzugefügt `` latexpdf`` Ziel im Schnellstart-Makefile.
• Markup:
• Die: rst: Rolle: `menuselection` und: rst: Rolle:.` Guilabel` Rollen unterstützen nun Und-Zeichen-Beschleuniger
• New kompakter doc Feldsyntax ist nun anerkannt: ``: param name Typ:. Description``
• Hinzugefügt `` Tab-width`` Option: rst: dir:. `Literalinclude` Richtlinie
• Hinzugefügt `` titlesonly`` Option: rst: dir:. `Toctree` Richtlinie
• Hinzufügen der `` und `` prepend`` append`` Optionen an den: rst: dir:. `Literalinclude` Richtlinie
• Alle docinfo Metadaten wird nun in den Dokument-Metadaten setzen, nicht nur der Autor.
• Die: rst: Rolle: `ref` Rolle können nun auf auch Tabellen, die von caption
.
• Die: rst: dir:. `Include` Richtlinie unterstützt jetzt absolute Pfade, die als relativ zum Quellverzeichnis interpretiert werden
• In der Python-Domäne, Referenzen, wie ``: func:. `.name``` Jetzt einstimmenden Namen mit einem beliebigen Präfix, wenn keine direkte Entsprechung gefunden aussehen
• Konfiguration:
• am: confval:. `Rst_prolog` Config-Wert
• am: confval:. `Html_secnumber_suffix` Config-Wert ist dem Kapitel Nummerierungsformat steuern
• am: confval:. `Html_compact_lists` Config-Wert zu kontrollieren kompakten Listen docutils 'verfügen
• Die: confval: `html_sidebars` Config-Wert kann nun Muster als Schlüssel enthalten, und die Werte können Listen, die ausdrücklich festlegen, welche Seitenleiste Vorlagen gemacht werden sollte. Das bedeutet, dass die eingebauten Seitenleiste Inhalte können nur selektiv aufgenommen werden.
• : confval:. `Html_static_path` können nun einzelne Datei enthält Einträge
• Die neue Universal-config-Wert: confval: `exclude_patterns` macht die alte: confval:` unused_docs`,: confval: `exclude_trees` und: confval:.` Exclude_dirnames` holt
• am: confval:. `Html_output_encoding` Config-Wert
• wurde hinzugefügt: confval: `latex_docclass` Config-Wert und machte die" twoside "document Option überschreibbar durch" einseitig "
.
• wurde hinzugefügt: confval:. `Trim_doctest_flags` Config-Wert, der standardmäßig wahr ist
• am: confval:. `Html_show_copyright` Config-Wert
• am: confval: `latex_show_pagerefs` und: confval:.` Latex_show_urls` Config-Werte
• Das Verhalten: confval: `html_file_suffix` leicht verändert: leerer String bedeutet jetzt" kein Suffix "anstelle von" Standard Suffix ", Verwendung` `None`` für" default Suffix "
.
• New Bauherren:
• Hinzugefügt Werft für epub-Format.
• Hinzugefügt Werft für Handbuchseiten.
• Es wurde ein Single-File-HTML-Builder.
• HTML-Ausgabe:
• Inline Rollen bekommen jetzt eine CSS-Klasse mit ihrem Namen, so dass Arten, um ihr Erscheinungsbild anpassen können. Domänenspezifische Rollen bekommen zwei Klassen, `` `` domain`` und Domain-rolename``.
• Referenzen bekommen jetzt die Klasse `` internal``, wenn sie innerhalb des gesamten Projektes, im Gegensatz zu internen auf die aktuelle Seite.
• Externe Verweise unterschiedlich mit dem neuen `` externalrefs`` Thema Option für die Standard-Theme gestylt werden.
• In der Standard-Theme, die Seitenleiste kann experimentell jetzt zusammenklappbar mit dem neuen `` collapsiblesidebar`` Thema Option vorgenommen werden.
• Toctrees werden nun in einer `` div`` Tag mit Klasse `` toctree-wrapper`` in HTML-Ausgabe gewickelt.
• Die: Daten:. `Toctree` abrufbare in Vorlagen hat nun eine` `maxdepth`` Schlüsselwort-Argument, um die Tiefe des erzeugten Baum steuern
• Die: Daten:. `Toctree` abrufbare in Templates übernimmt nun eine` `titles_only`` Schlüsselwort-Argument
• Hinzugefügt `` htmltitle`` Block in Layout-Vorlage.
• In der JavaScript-Suche, ermöglicht die Suche nach Objektnamen einschließlich dem Modulnamen, wie `` sys.argv``.
• Es wurden neue Thema `` haiku``, inspiriert von der Haiku OS Anleitung.
• Es wurden neue Thema `` nature``.
• Es wurden neue Thema `` agogo``, Erstellt von Andi Albrecht.
• Es wurden neue Thema `` scrolls``, erstellt von Armin Ronacher.
• Es wurde ein `` visitedlinkcolor`` Thema Option, um das Standard-Theme.
• Verbesserte Reaktionsfähigkeit der Suchseite durch Laden thesearch Index asynchron.
• Erweiterung API:
• am: Veranstaltung:. `Html-collect-pages`
• am: confval: `needs_sphinx` Konfigurationswert und: meth:.` ~ Sphinx.application.Sphinx.require_sphinx` Anwendung API-Methode
• am: meth:. `~ Sphinx.application.Sphinx.add_stylesheet` Anwendung API-Methode
• Erweiterungen:
• wurde hinzugefügt: mod: `~ sphinx.ext.viewcode` Erweiterung
.
• wurde hinzugefügt: mod: `~ sphinx.ext.extlinks` Erweiterung
.
• Unterstützung für Source-Bestellung von Mitgliedern in AutoDoc mit `` autodoc_member_order = 'bysource'``.
• am: confval:. `Autodoc_default_flags` Konfigurationswert, der verwendet werden, um Standard-Flags für alle AutoDoc Richtlinien auszuwählen
• Es wurde ein Weg für intersphinx auf Etiketten mit dem Namen in andere Projekte beziehen, und um das Projekt, die Sie verknüpfen möchten.
• Autodoc können nun dokumentieren Instanzattribute in `` __init__`` Methoden zugeordnet.
• Viele Verbesserungen und Korrekturen an das: mod:. `~ Sphinx.ext.autosummary` Erweiterung dank Pauli Virtanen
• Die: mod: `~ sphinx.ext.graphviz` Erweiterung können nun Ausgangs SVG anstelle von PNG-Bildern, von der confval gesteuert:.` Graphviz_output_format` Config-Wert
• Hinzugefügt `` alt`` Option: rst: dir:. `Graphviz` Erweiterung Richtlinien
• Hinzugefügt `` exclude`` Argument: func:. `.autodoc.between`
• Übersetzungen:
• zu Bojan Mihelac Hinzugefügt kroatische Übersetzung, Danke.
• zu Firat Ozgul Hinzugefügt türkische Übersetzung, Danke.
• Added Katalanisch Übersetzung, Danke an Pau Fernandez.
• Hinzugefügt vereinfachtes Chinesisch-Übersetzung.
• zu Hjorth Larsen Hinzugefügt dänische Übersetzung, Danke.
• zu Dalius Dobravolskas Hinzugefügt Lithuanian Übersetzung, Danke.

Was ist neu in Version 1.0b1:

• Unterstützung für Domänen wurde hinzugefügt. Eine Domäne ist eine Sammlung von Richtlinien und Rollen, die beschreiben alle Objekte zusammengehörig, zB Elemente einer Programmiersprache. Ein paar eingebaute Domains sind vorgesehen: - Python - C - C ++ - JavaScript - reStructuredText
• Die alte Markup für die Definition und die Verknüpfung zu C-Richtlinien werden nicht mehr ohne Aktivierung der `` oldcmarkup`` Erweiterung zu arbeiten.
• entfernt die Unterstützung für alte Abhängigkeit Versionen.
• Entfernt veraltete Elemente.

Was ist neu in Version 0.6.5:

• In AutoDoc, fixieren Sie die Auslassung einiger Modulelemente mit Dokumentationskommentare explizit dokumentiert.
• Fix Zuschneiden der Seitenleiste Bildlaufleiste mit `` stickysidebar`` Option der Standard-Theme.
• Immer zu generieren UNIX Zeilenumbrüche in der Schnellstartmakefile.
• Fix läuft mit `` -C`` unter Windows.
• In AutoDoc, ermöglichen die Anpassung der Signatur eines Objekts, wo die eingebauten Mechanismus versagt.
• Fix-Ausgang für Aufzählungslisten mit Startwerten in LaTeX.
• richtig Machen Sie den `` Start-after`` und `` end-before`` Optionen, um die `` literalinclude`` Richtlinie Arbeit, wenn nicht zusammen verwendet werden.
• Fix Link-Generierung in der LaTeX-Builder.

Was ist neu in Version 0.6.4:

• Verbesserte Handhabung von Nicht-Unicode-Zeichenfolgen in der Konfiguration.
• Fang OSErrors auftretenden beim Aufruf graphviz mit Argumenten es nicht versteht.
• Wiederherstellen Kompatibilität mit Pygments & gt;. = 1,2
• Fix Flucht von hyperref Ziele in LaTeX-Ausgabe.
• Fix Links von der `` erzeugt: doc:. `` Rolle für LaTeX-Ausgabe
• Sammeln Todo-Knoten, nachdem das gesamte Dokument gelesen wurde; dies ermöglicht, indem Substitution Referenzen in Todo Artikel.
• Sie eine explizite `` today`` Config-Wert in einem LaTeX-build nicht ignorieren.
• Das ist `` alt`` Text der Vererbung Diagramme jetzt viel sauberer.
• Bilder im Abschnitt Titel Ignorieren beim Erzeugen Link Bildunterschriften.
• Unterstützung Ausnahmemeldungen in den `` testoutput`` Blöcke des `` doctest`` Erweiterung.
• Line Blöcke richtig in HTML-Ausgabe gestylt.
• Aus den `` locale_dirs`` Config-Wert der Arbeit wieder.
• `` html_context`` Werte in der Befehlszeile über `` -A`` sollte nicht andere Werte in conf.py gegeben außer Kraft gegeben.
• Fix einen Fehler verhindert inkrementelle Umbauten für die `` dirhtml`` Builder.
• Befestigen Sie den Mangeln von Zitaten in einigen wörtliche Blöcke.
• Fix Pfad zum Suchindex für den `` dirhtml`` Builder.
• Fix eine Jython Kompatibilitätsproblem: machen die Abhängigkeit von der `` parser`` Modul optional
.
• In AutoDoc, fangen alle Fehler, die auf dem Modul Import auftreten, nicht nur `` ImportError``.
• Befestigen Sie den Umgang mit nicht-Daten, aber nicht-Methode Deskriptoren in AutoDoc.
• Beim Kopieren von Dateizeiten ignoriert OSErrors von `` os.utime angehoben () ``.

Anforderungen :

• Pygments 1.2 oder höher
• Jinja 2.3 oder höher
• Docutils 0/7 oder höher