Sphinx 1.3

Version 1.3.6 (veröffentlicht am 29. Februar 2016)

Hinzugefügte Funktionen

  • #1873, #1876, #2278: Fügt die HTML-Kontextvariable page_source_suffix hinzu. Dies sollte mit der source_parsers-Funktion eingeführt werden. Danke an Eric Holscher.

Behobene Fehler

  • #2265: Korrigiert, dass Babel verwendet wird, obwohl es in latex_elements deaktiviert wurde

  • #2295: Vermeidet Mutierungsfehler im Wörterbuch beim Aufzählen von Mitgliedern in Autodoc mit Python 3

  • #2291: Korrigiert den pdflatex-Fehler „Counter too large“ von Fußnoten innerhalb von Inhaltsverzeichnissen

  • #2292: Korrigiert, dass einige Fußnoten aus der LaTeX-Ausgabe verschwinden

  • #2287: sphinx.transforms.Locale verwendet immer den rst-Parser. Die i18n-Funktion von Sphinx sollte Parser unterstützen, die source_parsers angegeben haben.

  • #2290: Korrigiert, dass die Verwendung von amsfonts in sphinx.ext.mathbase die Wahl der mathematischen Schriftarten durch den Benutzer beeinträchtigen kann

  • #2324: Gibt einen Hinweis aus, wie die Rekursionstiefe erhöht werden kann, wenn sie erreicht wird.

  • #1565, #2229: Neue Warnung rückgängig machen; die neue Warnung wird ab Version 1.4 ausgelöst.

  • #2329: Aktualisiert die Umgebung erzwungen, wenn sich das Quellverzeichnis geändert hat.

  • #2019: Korrigiert, dass Domänenobjekte im Suchergebnis nicht escaped werden

Version 1.3.5 (veröffentlicht am 24. Januar 2016)

Behobene Fehler

  • Korrigiert, dass Zeilennummern bei Warnungen in LaTeX- und Texinfo-Buildern nicht angezeigt wurden

  • Korrigiert, dass Dateinamen bei Warnungen von Zitationen nicht angezeigt wurden

  • Korrigiert, dass Zeilennummern bei Warnungen in LaTeX- und Texinfo-Buildern nicht angezeigt wurden

  • Korrigiert, dass Zeilennummern bei Warnungen von Indizes nicht angezeigt wurden

  • #2026: Korrigiert, dass der LaTeX-Builder einen Fehler auslöst, wenn parsed-literal Links enthält

  • #2243: Ignoriert seltsame Docstring-Typen für Klassen, stürzt nicht ab

  • #2247: Korrigiert, dass #2205 make html für Definitionslisten mit Klassifikatoren, die wie reguläre Ausdrücke aussehende Zeichenketten enthalten, unterbricht

  • #1565: Sphinx gibt nun eine Warnung aus, dass das Hervorheben übersprungen wurde, wenn die Syntax für code-block, literalinclude usw. falsch ist.

  • #2211: Korrigiert, dass Absätze in Tabellenzellen in der LaTeX-Ausgabe nicht funktionieren

  • #2253: Die Option :pyobject: der Direktive literalinclude kann den folgenden Block bei Klassendefinitionen nicht erkennen, wenn der Block mit Leerzeilen oder Kommentarzeilen beginnt.

  • Korrigiert, dass das Inhaltsverzeichnis nicht angezeigt wird, wenn keine :maxdepth: für toctrees angegeben ist (siehe: #771)

  • Korrigiert die Warnmeldung für :numref:, wenn sich das Ziel in einem verwaisten Dokument befindet (siehe: #2244)

Version 1.3.4 (veröffentlicht am 12. Januar 2016)

Behobene Fehler

  • #2134: Korrigiert, dass die Abbildungsunterschrift mit Verweis einen LaTeX-Build-Fehler verursacht

  • #2094: Korrigiert, dass Rubriken mit Verweisen in LaTeX nicht funktionieren

  • #2147: Korrigiert, dass Code-Blöcke in literalinclude in LaTeX nicht seitenübergreifend umbrechen

  • #1833: Korrigiert, dass E-Mail-Adressen erneut angezeigt werden, wenn latex_show_urls nicht None ist

  • #2176: sphinx.ext.graphviz: verwendet <object> anstelle von <img> zum Einbetten von SVG

  • #967: Korrigiert, dass das Vererbungsdiagramm in SVG nicht hyperverknüpft (klickbar) ist

  • #1237: Korrigiert, dass Fußnoten in Definitionslisten in LaTeX nicht funktionieren

  • #2168: Korrigiert, dass die Direktive raw für den Text-Writer nicht funktioniert

  • #2171: Korrigiert, dass die URL-Überprüfung mit Unicode nicht funktioniert

  • #2182: LaTeX: Unterstützung für Dateinamen mit mehr als 1 Punkt

  • #2189: Korrigiert den Link zum vorherigen Geschwisterelement für die erste Datei in einem Unterverzeichnis, der die letzte Datei verwendet, anstatt des beabsichtigten vorherigen Elements von der Wurzel zum toctree

  • #2003: Korrigiert Dekodierungsfehler unter Python 2 (nur), wenn make linkcheck ausgeführt wird

  • #2186: Korrigiert die LaTeX-Ausgabe von mathbb in mathematischen Ausdrücken

  • #1480, #2188: LaTeX: Unterstützung für mathematische Ausdrücke in Abschnittsüberschriften

  • #2071: Korrigiert, dass dieselbe Fußnote in mehr als zwei Abschnittsüberschriften zu einem LaTeX/PDF-Fehler führt

  • #2040: Korrigiert UnicodeDecodeError in sphinx-apidoc, wenn der Autor Nicht-ASCII-Zeichen enthält

  • #2193: Korrigiert shutil.SameFileError, wenn Quell- und Zielverzeichnis identisch sind

  • #2178: Korrigiert, dass C++-Querverweise auf eine Funktion mit :cpp:any: nicht geparst werden können

  • #2206: Korrigiert, dass der LaTeX-Dokumenten-Build von Sphinx aufgrund von Fußnoten fehlschlägt

  • #2201: Korrigiert die falsche Tabellenunterschrift für Tabellen mit über 30 Zeilen

  • #2213: Setzt <blockquote> im klassischen Thema, um mit <p> übereinzustimmen

  • #1815: Korrigiert, dass linkcheck keine Ausnahme auslöst, wenn warniserror auf true gesetzt ist und ein Link defekt ist

  • #2197: Korrigiert die etwas kryptische Fehlermeldung für fehlende index.rst-Datei

  • #1894: Nicht aufgelistete Phony-Ziele in der Makefile von quickstart

  • #2125: Korrigiert das einheitliche Verhalten von kollabierten Feldern (GroupedField und TypedField)

  • #1408: Prüft die Gültigkeit von latex_logo vor dem Kopieren

  • #771: Korrigiert, dass die LaTeX-Ausgabe tocdepth nicht setzt

  • #1820: Unter Windows ist die Konsolenfärbung mit Colorama-Version 0.3.3 defekt. Sphinx verwendet jetzt Colorama >= 0.3.5, um dieses Problem zu vermeiden.

  • #2072: Korrigiert, dass Fußnoten in Kapitelüberschriften in der PDF-Ausgabe nicht erscheinen

  • #1580: Korrigiert, dass Absätze in longtable in der LaTeX-Ausgabe nicht funktionieren

  • #1366: Korrigiert, dass zentrierte Bilder in LaTeX nicht zentriert sind

  • #1860: Korrigiert, dass bei Verwendung von :samp: mit geschweiften Klammern in manpages die Schriftart nicht zurückgesetzt wird

  • #1610: Sphinx stürzt bei der japanischen Indizierung auf einigen Systemen ab

  • Korrigiert, dass Sphinx abstürzt, wenn die Mecab-Initialisierung fehlschlägt

  • #2160: Korrigiert, dass das Inhaltsverzeichnis von PDFs beschädigt ist, wenn ein Abschnitt ein Bild enthält

  • #2172: Korrigiert, dass die funktionierende Einleitung \py@lightbox in sphinx.sty defekt ist. Dank an jfbu.

  • #2198, #2205: make gettext generiert defekte msgids für Definitionslisten.

  • #2062: Zeichen in Doctests werden unter Python 2 falsch behandelt.

  • #2225: Korrigiert, dass die Verknüpfung nicht durchgeführt wird, wenn die Option nicht mit einem Bindestrich beginnt

  • #2226: Korrigiert, dass mathematische Ausdrücke nicht HTML-encodiert werden, wenn :nowrap: angegeben ist (jsmath, mathjax)

  • #1601, #2220: Die Rolle any unterbricht das Verhalten von erweiterten Domänen. Betroffene Erweiterungen unterstützen resolve_any_xref nicht und resolve_xref gibt einen problematischen Knoten anstelle von None zurück. sphinxcontrib-httpdomain ist eine davon.

  • #2229: Korrigiert, dass keine Warnung für unbekannte Optionen ausgegeben wird

Version 1.3.3 (veröffentlicht am 2. Dezember 2015)

Behobene Fehler

  • #2177: Korrigiert, dass Parallelbetrieb hängt

  • #2012: Korrigiert, dass eine Ausnahme auftritt, wenn numfig_format ungültig ist

  • #2142: Stellt nicht minimierten JS-Code in sphinx/search/non-minified-js/*.js für die Quellcodeverteilung auf PyPI bereit.

  • #2148: Fehler beim Erstellen des Devhelp-Ziels mit einem Nicht-ASCII-Dokument.

Version 1.3.2 (veröffentlicht am 29. November 2015)

Hinzugefügte Funktionen

  • #1935: Macht „numfig_format“ in latex_elements überschreibbar.

Behobene Fehler

  • #1976: Vermeidet die „2.0“-Version von Babel, da sie unter Windows nicht funktioniert.

  • Fügt ein „default.css“-Stylesheet hinzu (das „classic.css“ importiert) zur Kompatibilität

  • #1788: Die Graphviz-Erweiterung löst eine Ausnahme aus, wenn die Caption-Option vorhanden ist.

  • #1789: Die Option :pyobject: der Direktive literalinclude schließt nachfolgende Zeilen nach Klassendefinitionen ein

  • #1790: literalinclude entfernt leere Zeilen am Anfang und Ende

  • #1802: Lädt Plugin-Themes automatisch, wenn theme.conf sie als ‚inherit‘ verwendet. Danke an Takayuki Hirai.

  • #1794: Benutzerdefinierte Themes, die von alabaster oder sphinx_rtd_theme abgeleitet sind, können das Basis-Theme nicht finden.

  • #1834: Kompatibilität für Docutils 0.13: Das Schlüsselwortargument handle_io_errors für docutils.io.FileInput verursacht TypeError.

  • #1823: Ein ‚.‘ als <module_path> für sphinx-apidoc verursacht einen unfreundlichen Fehler. Jetzt wird ‚.‘ automatisch in einen absoluten Pfad umgewandelt.

  • Korrigiert einen Absturz beim Einrichten von Erweiterungen, die keine Metadaten unterstützen.

  • #1784: Stellt nicht minimierten JS-Code in sphinx/search/non-minified-js/*.js bereit

  • #1822, #1892: Korrigiert Regression für #1061. Autosummary kann keine Dokumentation für importierte Mitglieder generieren seit Sphinx 1.3b3. Danke an Eric Larson.

  • #1793, #1819: „Siehe auch“ vermisst einen Zeilenumbruch in der Textausgabe. Danke an Takayuki Hirai.

  • #1780, #1866: „make text“ zeigt das Schlüsselwort „class“ zweimal an. Danke an Takayuki Hirai.

  • #1871: Korrigiert die LaTeX-Ausgabe von Tabellen mit einer Spalte und mehreren Zeilen.

  • Umgeht den fehlenden HTMLParserError in Python 3.5.

  • #1949: Verwendet safe_getattr im Coverage-Builder, um Abstürze mit Deskriptoren, die benutzerdefiniertes Verhalten haben, zu vermeiden.

  • #1915: Generiert keine intelligenten Anführungszeichen in Feldtypen-Annotationen.

  • #1796: Unter py3 verursachte die automatisierte .mo-Erstellung UnicodeDecodeError.

  • #1923: Verwendet Babel-Funktionen nur, wenn das Babel-LaTeX-Element nicht leer ist.

  • #1942: Korrigiert einen KeyError in websupport.

  • #1903: Korrigiert die seltsame ID-Generierung für Glossarbegriffe.

  • make text stürzt ab, wenn ein Definitionslistenelement mehr als einen Klassifikator hat, wie z.B.: Begriff : Klassifikator1 : Klassifikator2.

  • #1855: make gettext generiert eine defekte po-Datei für Definitionslisten mit Klassifikatoren.

  • #1869: Korrigiert Probleme beim Umgang mit Dateien, die Nicht-ASCII-Zeichen enthalten. Danke an Marvin Schmidt.

  • #1798: Korrigiert den LaTeX-Build mit Verweisen in Titeln.

  • #1725: In einer Py2-Umgebung verursacht Doctest mit Nicht-ASCII-Zeichen eine 'ascii' codec can't decode byte-Ausnahme.

  • #1540: Korrigiert RuntimeError bei zyklischen Verweisen auf toctree

  • #1983: Die i18n-Übersetzungsfunktion unterbricht Verweise, die Abschnittsnamen verwenden.

  • #1990: Verwendet die caption von toctree als Titel des Inhaltsverzeichnisses in LaTeX

  • #1987: Korrigiert, dass das kaufmännische Und (&) in :menuselection: und :guilabel: im LaTeX-Builder ignoriert wird

  • #1994: Mehr Unterstützung für nicht-standardmäßige Parser (wie den recommonmark-Parser) für die Übersetzungs- und WebSupport-Funktionen. Nun wird node.rawsource als Fallback auf node.astext() während der Docutils-Transformation gesetzt.

  • #1989: „make blahblah“ unter Windows zeigt jedes Mal Hilfemeldungen für sphinx-build an. Dies wurde durch eine falsche make.bat verursacht, die von Sphinx 1.3.0/1.3.1 generiert wurde.

  • In einer Py2-Umgebung sollte die von sphinx-quickstart generierte conf.py ein mit u versehenes Konfigurations-Wert für ‚version‘ und ‚release‘ haben.

  • #2102: Unter Windows + Py3 verursacht die Verwendung von |today| und ein Nicht-ASCII-Datumsformat UnicodeEncodeError.

  • #1974: UnboundLocalError: lokale Variable ‚domain‘ vor der Zuweisung referenziert, wenn die Rolle any und sphinx.ext.intersphinx gleichzeitig verwendet werden.

  • #2121: Mehrwortsuche findet keine Seiten, wenn Wörter auf dem Seitentitel und dem Seiteninhalt verteilt sind.

  • #1884, #1885: HTML-Themes von Plugins können keine anderen Plugin-Themes erben. Danke an Suzumizaki.

  • #1818: Die sphinx.ext.todo-Direktive generiert ein defektes HTML-Klassenattribut als ‚admonition-‘, wenn language mit einem Nicht-ASCII-Sprachbereich wie ‚ru‘ oder ‚ja‘ angegeben ist. Um dies zu beheben, kann die todo-Direktive nun die Option :class: verwenden.

  • #2140: Korrigiert, dass Fußnoten in Tabellen in LaTeX defekt sind

  • #2127: MecabBinder für die HTML-Suchfunktion funktioniert nicht mit Python 3. Danke an Tomoko Uchida.

Version 1.3.1 (veröffentlicht am 17. März 2015)

Behobene Fehler

  • #1769: Ermöglicht die Erstellung von Schnellstartdateien/-verzeichnissen für ein Zielverzeichnis, das vorhandene Dateien/Verzeichnisse nicht überschreibt. Danke an WAKAYAMA shirou.

  • #1773: sphinx-quickstart akzeptiert keine Nicht-ASCII-Zeichen als Optionsargument.

  • #1766: Die Meldung „mindestens Python 2.6 zum Ausführen“ ist bestenfalls irreführend.

  • #1772: Querverweise in Docstrings wie :param .write: unterbrechen den Build.

  • #1770, #1774: literalinclude mit leerer Datei löst eine Ausnahme aus. Danke an Takayuki Hirai.

  • #1777: Sphinx 1.3 kann kein zusätzliches Theme laden. Danke an tell-k.

  • #1776: source_suffix = ['.rst'] verursacht eine unfreundliche Fehlermeldung bei früheren Versionen.

  • #1771: Die automatische .mo-Erstellung funktioniert nicht richtig.

  • #1783: Autodoc: Python2 erlaubt Unicode-Strings in __all__. Danke an Jens Hedegaard Nielsen.

  • #1781: Das Setzen von html_domain_indices auf eine Liste löst eine Typüberprüfungswarnung aus.

Version 1.3 (veröffentlicht am 10. März 2015)

Inkompatible Änderungen

  • Die Rollen ref, term und menusel generieren nun keine emphasis-Knoten mehr. Wenn Sie den Kursivstil beibehalten möchten, passen Sie Ihr Stylesheet an.

  • Die Rolle numref verwendet %s als Sonderzeichen, um die Position von Abbildungsnummern anstelle des #-Symbols anzugeben.

Hinzugefügte Funktionen

  • Fügt praktische Direktiven und Rollen zur C++-Domäne hinzu: Direktive cpp:var als Alias für cpp:member, Rolle :cpp:var als Alias für :cpp:member und Rolle any für Querverweise auf beliebige C++-Deklarationen. #1577, #1744

  • Der Konfigurationswert source_suffix kann nun eine Liste mehrerer Suffixe sein.

  • Fügt die Möglichkeit hinzu, Quell-Parser nach Quellsuffix mit dem Konfigurationswert source_parsers anzugeben.

  • #1675: Ein neuer Builder, AppleHelpBuilder, wurde hinzugefügt, der Apple Help Books erstellt.

Behobene Fehler

  • Die Änderung in 1.3b3 unterbricht eine frühere gettext-Ausgabe, die duplizierte msgid enthält, wie z.B. „foo bar“ und „Versionsänderungen in 1.3: foo bar“.

  • #1745: Der LaTeX-Builder verursacht eine überschrittene maximale Rekursionstiefe, wenn eine Fußnote selbst eine Fußnotenmarkierung hat.

  • #1748: SyntaxError in sphinx/ext/ifconfig.py mit Python 2.6.

  • #1658, #1750: Es wird kein Link erstellt (und keine Warnung ausgegeben), wenn die Option nicht mit -, / oder + beginnt. Danke an Takayuki Hirai.

  • #1753: C++, fehlende Unterstützung für komplexere Deklarationen hinzugefügt.

  • #1700: Fügt die Option :caption: für die toctree-Direktive hinzu.

  • #1742: Die Option :name: wird für die Direktiven toctree, code-block und literalinclude bereitgestellt.

  • #1753: Falsche Abschnittsüberschriften in der Suche, die ab 1.3b3 eingeführt wurden.

  • #1746: C++, Namensauflösungsverfahren korrigiert und fehlende Auflösungen in Deklarationen hinzugefügt.

  • #1765: C++, alte ID-Generierung zur Verwendung vollqualifizierter Namen korrigiert.

Dokumentation

  • #1651: Fügt die Feldbeschreibung vartype für die Python-Domäne hinzu.

Version 1.3b3 (veröffentlicht am 24. Februar 2015)

Inkompatible Änderungen

  • Aktualisierungen der Abhängigkeitsanforderungen: Docutils 0.11, Pygments 2.0

  • Der Konfigurationswert gettext_enables wurde in gettext_additional_targets umbenannt.

  • #1735: Verwendet https://docs.pythonlang.de/ anstelle des http-Protokolls. Dies wurde für sphinx.ext.intersphinx und einige Dokumentationen verwendet.

Hinzugefügte Funktionen

  • #1346: Fügt ein neues Standard-Theme hinzu;

    • Fügt das ‚alabaster‘-Theme hinzu.

    • Fügt das ‚sphinx_rtd_theme‘-Theme hinzu.

    • Das HTML-Theme ‚default‘ wurde in ‚classic‘ umbenannt. ‚default‘ ist weiterhin verfügbar, wird aber eine Empfehlung zur Verwendung des neuen ‚alabaster‘-Themes ausgeben.

  • Fügt den Konfigurationswert highlight_options hinzu.

  • Der Konfigurationswert language ist nun in den HTML-Vorlagen verfügbar.

  • Das Ereignis env-updated kann nun einen Wert zurückgeben, der als Iterable zusätzlicher Dokumentennamen interpretiert wird, die neu geschrieben werden müssen.

  • #772: Unterstützung für Geltungsbereiche und nicht-Geltungsbereiche von Enums in C++. Aufzählungselemente in nicht-Geltungsbereichen werden zusätzlich zum Enum-Geltungsbereich in den übergeordneten Geltungsbereich eingefügt.

  • Fügt die Konfigurationsoption todo_include_todos zur Schnellstart-Konfigurationsdatei hinzu, die wie in der Dokumentation beschrieben behandelt wird.

  • HTML-Brotkrümel-Elemente haben die Klasse „nav-item“ und „nav-item-N“ (wie nav-item-0, 1, 2…).

  • Neue Option sphinx-quickstart --use-make-mode zum Erstellen einer Makefile, die den Sphinx-Build-Make-Modus verwendet.

  • #1235: i18n: Mehrere Knoten können übersetzt werden, wenn sie in gettext_additional_targets in conf.py gesetzt sind. Unterstützte Knoten sind

    • ‚literal-block‘

    • ‚doctest-block‘

    • ‚raw‘

    • ‚image‘

  • #1227: Fügt die Konfigurationsoption html_scaled_image_link zu conf.py hinzu, um den skalierten Bildlink zu steuern.

Behobene Fehler

  • Der LaTeX-Writer generiert nun die korrekte Auszeichnung für Zellen, die mehrere Zeilen überspannen.

  • #1674: Stürzt nicht ab, wenn __all__ eines Moduls keine Liste von Strings ist.

  • #1629: Verwendet VerbatimBorderColor, um dem code-block in LaTeX einen Rahmen hinzuzufügen

  • Unter Windows funktionierte der Make-Modus auf der Win32-Plattform nicht, wenn Sphinx als python sphinx-build.py aufgerufen wurde.

  • #1687: linkcheck behandelt nun 401 Unauthorized-Antworten als „funktionierend“.

  • #1690: toctrees mit der Option glob können nun auch Einträge für einzelne Dokumente mit explizitem Titel enthalten.

  • #1591: Die HTML-Suchergebnisse für C++-Elemente enthalten nun korrekte seitenübergreifende Links.

  • Bizstyle-Theme: Lange Titelseiten erstellen lange Brotkrümel, die das Seitenlayout beeinträchtigen.

  • Bizstyle-Theme: Alle Brotkrümel-Elemente werden auf einigen mobilen Browsern (iPhone5s Safari) zu ‚Top‘.

  • #1722: Stellt das Verhalten der toctree()-Templatefunktion wieder her, das in 1.3b1 geändert wurde.

  • #1732: i18n: lokalisierte Tabellenunterschriften lösen eine Ausnahme aus.

  • #1718: :numref: funktioniert nicht mit Großbuchstaben in der Bezeichnung

  • #1630: CSS-Konflikte auflösen, das div.container CSS-Ziel für den Wrapper des Literalblocks wurde in div.literal-block-wrapper umbenannt.

  • sphinx.util.pycompat wurde in Bezug auf seine Abwärtskompatibilität wiederhergestellt; zur Entfernung in Sphinx 1.4 vorgesehen.

  • #1719: Der LaTeX-Writer respektiert die Option numref_format in Unterschriften nicht

Version 1.3b2 (veröffentlicht am 5. Dezember 2014)

Inkompatible Änderungen

  • Aktualisiert das gebündelte ez_setup.py für setuptools-7.0, das Python 2.6 oder höher erfordert.

Hinzugefügte Funktionen

  • #1597: Fügt die Möglichkeit hinzu, einen neuen Vorlagennamen von html-page-context zurückzugeben.

  • PR#314, #1150: Konfigurationswerte werden nun auf ihren Typ überprüft. Eine Warnung wird ausgegeben, wenn der konfigurierte und der Standardwert nicht denselben Typ haben und keine gemeinsame nicht-triviale Basisklasse teilen.

Behobene Fehler

  • PR#311: sphinx-quickstart funktioniert nicht unter Python 3.4.

  • Korrigiert, dass autodoc_docstring_signature mit Signaturen in Klassendokumentationsstrings nicht funktioniert.

  • Der erneute Build stürzt unerwartet ab, wenn Quelldateien hinzugefügt wurden.

  • #1607: Korrigiert einen Absturz beim Erstellen von latexpdf mit der Klasse „howto“

  • #1251: Korrigiert erneut. Abschnitte, deren Tiefe geringer ist als :tocdepth:, sollten nicht in der linken Navigationsleiste angezeigt werden.

  • Der Make-Modus funktionierte auf der Win32-Plattform nicht, wenn Sphinx mit einem Wheel-Paket installiert wurde.

Version 1.3b1 (veröffentlicht am 10. Oktober 2014)

Inkompatible Änderungen

  • Unterstützung für Python 2.5, 3.1 und 3.2 wurde eingestellt.

  • Unterstützung für Docutils-Versionen bis 0.9 wurde eingestellt.

  • Die Erweiterung sphinx.ext.oldcmarkup wurde entfernt.

  • Die veralteten Konfigurationswerte exclude_trees, exclude_dirnames und unused_docs wurden entfernt.

  • Ein neuer Knoten, sphinx.addnodes.literal_strong, wurde hinzugefügt, für Text, der buchstäblich (d.h. keine intelligenten Anführungszeichen) in fetter Schrift erscheinen soll. Benutzerdefinierte Writer müssen angepasst werden, um diesen Knoten zu verarbeiten.

  • PR#269, #1476: Ersetzt das <tt>-Tag durch <code>. Benutzerdefinierte Stylesheets sollten aktualisiert werden, wenn das CSS einige Stile für das tt>-Tag enthält. Danke an Takeshi Komiya.

  • #1543: templates_path wird automatisch zu exclude_patterns hinzugefügt, um das Lesen von Autosummary-RST-Vorlagen im Vorlagenverzeichnis zu vermeiden.

  • Benutzerdefinierte Domänen sollten die neue Methode Domain.resolve_any_xref implementieren, damit die Rolle any ordnungsgemäß funktioniert.

  • Gettext-Builder: Gettext gibt standardmäßig keine UUID-Informationen an generierte POT-Dateien aus. Bitte setzen Sie gettext_uuid auf True, um UUID-Informationen auszugeben. Wenn zusätzlich das 3rd-Party-Paket python-levenshtein installiert ist, verbessert dies die Berechnungszeit.

  • Gettext-Builder: Extraktion/Anwendung des ‚index‘-Knotens wird standardmäßig deaktiviert. Bitte setzen Sie ‚index‘ auf gettext_enables, um die Indexeinträge zu extrahieren.

  • PR#307: Fügt einen Rahmen für code-block in LaTeX hinzu. Danke an Takeshi Komiya.

Hinzugefügte Funktionen

  • Fügt Unterstützung für Python 3.4 hinzu.

  • Fügt Unterstützung für Docutils 0.12 hinzu

  • Fügt die Erweiterung sphinx.ext.napoleon für die Unterstützung von NumPy- und Google-Stil-Docstrings hinzu.

  • Fügt Unterstützung für paralleles Lesen (Parsen) von Quelldateien mit der Option sphinx-build -j hinzu. Drittanbietererweiterungen müssen auf Kompatibilität geprüft und gegebenenfalls angepasst werden, wenn sie Informationen im Build-Umgebungsobjekt speichern. Siehe env-merge-info.

  • Fügt die Rolle any hinzu, die verwendet werden kann, um einen Querverweis eines beliebigen Typs in einer beliebigen Domäne zu finden. Benutzerdefinierte Domänen sollten die neue Methode Domain.resolve_any_xref implementieren, damit dies ordnungsgemäß funktioniert.

  • Ausnahmelogs enthalten nun die letzten 10 von Sphinx ausgegebenen Nachrichten.

  • Fügt Unterstützung für Erweiterungsversionen hinzu (ein String, der von setup() zurückgegeben wird; diese können in den Traceback-Protokolldateien angezeigt werden). Versionsanforderungen für Erweiterungen können in Projekten mit dem neuen Konfigurationswert needs_extensions angegeben werden.

  • Das Ändern der Standardrolle innerhalb eines Dokuments mit der Direktive default-role wird nun unterstützt.

  • PR#214: Fügt Stemming-Unterstützung für 14 Sprachen hinzu, damit die integrierte Dokumentensuche diese nun verarbeiten kann. Danke an Shibukawa Yoshiki.

  • PR#296, PR#303, #76: Numfig-Funktion: Weist Zahlen Abbildungen, Tabellen und Codeblöcken zu. Diese Funktion wird mit numfig, numfig_secnum_depth und numfig_format konfiguriert. Außerdem ist die Rolle numref verfügbar. Danke an Takeshi Komiya.

  • PR#202: Erlaubt mit „.“ und „~“ beginnende Referenzen in :param:-Doc-Feldern für Python.

  • PR#184: Fügt autodoc_mock_imports hinzu, das das Mocken von Imports externer Module ermöglicht, die beim Autodokumentieren nicht vorhanden sein müssen.

  • #925: Ermöglicht die Bereitstellung von listenbasierten Konfigurationswerten über die Befehlszeile, z.B. -D key=val1,val2.

  • #668: Ermöglicht die Zeilennummerierung der Direktiven code-block und literalinclude, beginnend bei einer beliebigen Zeilennummer, mit einer neuen Option lineno-start.

  • PR#172, PR#266: Die Direktiven code-block und literalinclude können jetzt eine Option caption haben, die einen Dateinamen vor dem Code in der Ausgabe anzeigt. Dank an Nasimul Haque, Takeshi Komiya.

  • Aufforderung zur Dokumentationssprache in sphinx-quickstart.

  • PR#217: Konfigurationswerte hinzugefügt, um UUID- und Standortinformationen in generierten gettext-Katalogen zu unterdrücken.

  • PR#236, #1456: apidoc: Option -M hinzugefügt, um Moduldokumentation vor Untermoduldokumentation zu platzieren. Dank an Wes Turner und Luc Saffre.

  • #1434: Bereitstellung von nicht minifizierten JS-Dateien für jquery.js und underscore.js, um die Quelle der minifizierten Dateien zu verdeutlichen.

  • PR#252, #1291: Unterstützung für farbige Konsolen unter Windows. Dank an meu31.

  • PR#255: Beim Generieren von LaTeX-Referenzen werden auch LaTeX-Ziel-/Anker für die auf dem Knoten definierten IDs eingefügt. Dank an Olivier Heurtier.

  • PR#229: Registrierung anderer Übersetzer erlaubt. Dank an Russell Sim.

  • API app.set_translator() hinzugefügt, um Docutils-Übersetzerklassen wie html_translator_class zu registrieren oder zu überschreiben.

  • PR#267, #1134: Parameter 'diff' zu literalinclude hinzugefügt. Dank an Richard Wall und WAKAYAMA shirou.

  • PR#272: Theme 'bizstyle' hinzugefügt. Dank an Shoji KUMAGAI.

  • Automatische Kompilierung von *.mo-Dateien aus *.po-Dateien, wenn gettext_auto_build True (Standard) ist und *.po neuer ist als die *.mo-Datei.

  • #623: sphinx.ext.viewcode unterstützt importierte Funktions-/Klassenaliase.

  • PR#275: sphinx.ext.intersphinx unterstützt mehrere Ziele für das Inventar. Dank an Brigitta Sipocz.

  • PR#261: Event env-before-read-docs hinzugefügt, das verbunden werden kann, um die Reihenfolge der Dokumente vor dem Lesen durch die Umgebung zu ändern.

  • #1284: Programmoptionen, die mit option dokumentiert sind, können jetzt mit + beginnen.

  • PR#291: Die Beschriftung von code-block wird als Titel des Ref-Ziels erkannt. Dank an Takeshi Komiya.

  • PR#298: Neue API hinzugefügt: add_latex_package(). Dank an Takeshi Komiya.

  • #1344: gettext_enables hinzugefügt, um die Extraktion von 'index' in die gettext-Katalogausgabe zu ermöglichen / Übersetzungskatalog auf die generierte Dokumentation anzuwenden.

  • PR#301, #1583: Zeilennummerierung der Direktive literalinclude kann jetzt mit der des enthaltenen Dateis übereinstimmen, unter Verwendung einer neuen Option lineno-match. Dank an Jeppe Pihl.

  • PR#299: Verschiedene Optionen für sphinx-quickstart hinzugefügt. Die Option --quiet überspringt den Dialogmodus. Dank an WAKAYAMA shirou.

  • #1623: Rückgabetypen, die mit :rtype: angegeben sind, werden jetzt, wenn möglich, in Links umgewandelt.

Behobene Fehler

  • #1438: jQuery-Version von 1.8.3 auf 1.11.1 aktualisiert.

  • #1568: Absturz behoben, wenn eine "zentrierte" Direktive eine Referenz enthält.

  • Nun funktioniert sphinx.ext.autodoc wieder mit python-2.5.

  • #1563: add_search_language() löst AssertionError für den richtigen Argumenttyp aus. Dank an rikoman.

  • #1174: Problem mit intelligenten Anführungszeichen in Rollen wie program oder makevar behoben.

  • PR#235: Kommentar in der Websupport-DB-Schema fehlte die Länge des Feldes node_id. Dank an solos.

  • #1466,PR#241: Fehler im C++-Domänenparser beim Parsen von C+11 "variadic templates"-Deklarationen behoben. Dank an Victor Zverovich.

  • #1459,PR#244: Standard-Mathjax-JS-Pfad zeigt auf http://, was auf HTTPS-Servern zu Mixed-Content-Fehlern führt. Dank an sbrandtb und robo9k.

  • PR#157: autodoc entfernt überflüssige Signaturen von @property-dekorierten Attributen. Dank an David Ham.

  • PR#159: Coverage-Ziele zu generierten Makefiles und make.bat von quickstart hinzugefügt. Dank an Matthias Troffaes.

  • #1251: Bei Angabe der Option :numbered: für toctree und :tocdepth: Metadaten wird die Unterabschnittsnummer, die eine tiefere Tiefe als :tocdepth: hat, reduziert.

  • PR#260: Unterstriche in Zitat-Labels für den LaTeX-Export kodiert. Dank an Lennart Fricke.

  • PR#264: Fehler beim Auflösen von Xrefs für Figure-Knoten mit der Option :name: behoben. Dank an Takeshi Komiya.

  • PR#265: Fehler beim Erfassen von Bildunterschriften von Graphviz-Knoten durch Xref behoben. Dank an Takeshi Komiya.

  • PR#263, #1013, #1103: Neufassung der C++-Domäne. Dank an Jakob Lykke Andersen.

    • Hyperlinks zu allen gefundenen verschachtelten Namen und Template-Argumenten (#1103).

    • Unterstützung für Funktionstypen überall, z. B. in std::function<bool(int, int)> (#1013).

    • Unterstützung für virtuelle Funktionen.

    • Interpretation von Funktionsargumenten geändert, um Standard-Prototyp-Deklarationen zu folgen, d. h. void f(arg) bedeutet, dass arg der Typ des Arguments ist, anstatt sein Name zu sein.

    • Tests aktualisiert.

    • Dokumentation aktualisiert mit detaillierter Beschreibung, welche Deklarationen unterstützt werden und wie Namespace-Deklarationen die Deklarations- und Cross-Reference-Suche beeinflussen.

    • Indexnamen können sich jetzt unterscheiden. Elemente werden nach ihrem vollständig qualifizierten Namen indiziert. Es sollte ziemlich einfach sein, dieses Verhalten zu ändern und potenziell auch nach Namespaces/Klassen zu indizieren.

  • PR#258, #939: Option dedent für code-block und literalinclude hinzugefügt. Dank an Zafar Siddiqui.

  • PR#268: Fehler bei der Abschnittsnummerierung im singlehtml-Modus behoben. Dies ist immer noch eine Ad-hoc-Lösung, da es ein Problem mit widersprüchlichen Abschnitts-IDs gibt. Dank an Takeshi Komiya.

  • PR#273, #1536: RuntimeError mit nummeriertem zirkulärem toctree behoben. Dank an Takeshi Komiya.

  • PR#274: Die URL wird als Standardtitelwert festgelegt, wenn eine URL in toctree vorkommt. Dank an Takeshi Komiya.

  • PR#276, #1381: rfc und pep Rollen unterstützen benutzerdefinierten Linktext. Dank an Takeshi Komiya.

  • PR#277, #1513: Hervorhebungen für Funktionszeiger in Argumentlisten von c:function. Dank an Takeshi Komiya.

  • PR#278: Fehler behoben, dass Abschnittseinträge doppelt angezeigt wurden, wenn toctree nur unter einer Direktive platziert wurde. Dank an Takeshi Komiya.

  • #1547: pgen2-Tokenizer erkennt das ...-Literal (Ellipsis für py3) nicht.

  • PR#294: Im LaTeX-Builder werden Float-Umgebungen beim Schreiben von literal_block umschlossen, um die Trennung von Bildunterschrift und Körper zu vermeiden. Dank an Takeshi Komiya.

  • PR#295, #1520: Mechanismus make.bat latexpdf kehrt in das aktuelle Verzeichnis zurück. Dank an Peter Suter.

  • PR#297, #1571: Eigenschaft imgpath zu allen Buildern hinzugefügt. Dies erleichtert die Entwicklung von Builder-Erweiterungen. Dank an Takeshi Komiya.

  • #1584: Verweist im HTML-"Top"-Link auf das Master-Dokument.

  • #1585: Autosummary von Modulen war in Sphinx 1.2.3 defekt.

  • #1610: Sphinx verursacht AttributeError, wenn die MeCab-Suchoption aktiviert ist und python-mecab nicht installiert ist.

  • #1674: Stürzt nicht ab, wenn __all__ eines Moduls keine Liste von Strings ist.

  • #1673: Abstürze mit nitpick_ignore und :doc:-Referenzen behoben.

  • #1686: Die ifconfig-Direktive berücksichtigt keine Standardkonfigurationswerte.

  • #1642: Nur ein Suchergebnis in Chrome behoben.

Dokumentation

  • Klarstellung zur Syntax von Tags hinzugefügt. (doc/markup/misc.rst)