Sphinx 1.2

Release 1.2.3 (veröffentlicht 1. September 2014)

Hinzugefügte Funktionen

• #1518: Der Befehl sphinx-apidoc verfügt jetzt über eine Option --version, um Versionsinformationen anzuzeigen und zu beenden

• Neue Lokalisierungen: Hebräisch, europäisches Portugiesisch, Vietnamesisch.

Behobene Fehler

• #636: Beibehaltung gerader einfacher Anführungszeichen in Literalblöcken im LaTeX-Build.

• #1419: Generierte i18n sphinx.js-Dateien fehlen Nachrichtenkatalog-Einträge aus „.js_t“ und „.html“. Das Problem trat erstmals in Sphinx 1.1 auf

• #1363: i18n korrigieren: fehlende Querverweise der Python-Domäne mit der Direktive currentmodule oder currentclass.

• #1444: autosummary erstellt die Beschreibung nicht aus Attribut-Docstrings.

• #1457: In der Python3-Umgebung verursacht linkcheck einen Fehler „Can’t convert ‘bytes’ object to str implicitly“, wenn die Linkziel-URL einen Hash-Teil enthält. Dank an Jorge_C.

• #1467: Ausnahme unter Python3, wenn eine nicht vorhandene Methode durch automethod angegeben wird

• #1441: autosummary kann verschachtelte Klassen nicht korrekt verarbeiten.

• #1499: Mit einer nicht aufrufbaren setup in conf.py gibt sphinx-build jetzt eine benutzerfreundliche Fehlermeldung aus.

• #1502: In autodoc, Korrektur der Anzeige von Parameterstandards, die Backslashes enthalten.

• #1226: autodoc, autosummary: das Importieren von setup.py durch automodule löst den Setup-Prozess aus und führt sys.exit() aus. Sphinx vermeidet nun die SystemExit-Ausnahme und gibt Warnungen aus, ohne unerwartet abzubrechen.

• #1503: Die py:function-Direktive generiert fälschlicherweise eine Signatur, wenn ein Standardparameter mit einer leeren Liste [] angegeben wird. Dank an Geert Jansen.

• #1508: Nicht-ASCII-Dateiname löst eine Ausnahme aus bei make singlehtml, latex, man, texinfo und changes.

• #1531: In der Python3-Umgebung verursacht docutils.conf mit ‘source_link=true’ im allgemeinen Abschnitt einen Typfehler.

• PR#270, #1533: Nicht-ASCII-Docstrings verursachen einen UnicodeDecodeError bei Verwendung mit der inheritance-diagram-Direktive. Dank an WAKAYAMA shirou.

• PR#281, PR#282, #1509: Die TODO-Erweiterung ist nicht mit websupport kompatibel. Dank an Takeshi Komiya.

• #1477: gettext extrahiert keine nodes.line in einer Tabelle oder Liste.

• #1544: make text generiert eine falsche Tabelle, wenn leere Tabellenzellen vorhanden sind.

• #1522: Fußnoten aus Tabellen werden in LaTeX doppelt angezeigt. Dieses Problem trat seit Sphinx 1.2.1 durch #949 auf.

• #508: Sphinx wird jedes Mal mit Null beendet, wenn es von der setup.py-Befehlszeile aufgerufen wird. Bsp.: python setup.py build_sphinx -b doctest gibt Null zurück, auch wenn doctest fehlschlägt.

Release 1.2.2 (veröffentlicht 2. März 2014)

Behobene Fehler

• PR#211: Beim Überprüfen der Existenz der html_logo-Datei, überprüfen Sie den vollständigen relativen Pfad und nicht den Basisnamen.

• PR#212: Korrigiert Traceback mit autodoc und __init__-Methoden ohne Docstring.

• PR#213: Korrigiert einen fehlenden Import im setup-Befehl.

• #1357: Optionsnamen, die mit der option-Direktive dokumentiert sind, dürfen nun wieder mit einem Bindestrich oder Schrägstrich beginnen, und die Referenzierung funktioniert korrekt.

• #1358: Korrigiert die Handhabung von Bildpfaden außerhalb des Quellverzeichnisses bei Verwendung des „Wildcard“-Referenzstils.

• #1374: Korrektur für autosummary, das zu lange Zusammenfassungen generiert, wenn die erste Zeile nicht mit einem Punkt endet.

• #1383: Korrektur der Python 2.5-Kompatibilität von sphinx-apidoc.

• #1391: Verhindert tatsächlich die gleichzeitige Verwendung der Erweiterungen „pngmath“ und „mathjax“ in sphinx-quickstart.

• #1386: Korrigiert einen Fehler, der verhinderte, dass mehr als ein Theme über den Entry-Point-Mechanismus hinzugefügt wurde.

• #1370: Ignoriert „toctree“-Knoten im Text-Writer, anstatt eine Ausnahme auszulösen.

• #1364: Korrigiert, dass ‘make gettext’ fehlschlägt, wenn die Direktive ‘.. todolist::’ vorhanden ist.

• #1367: Korrigiert eine Änderung von PR#96, die die Schnittstelle/das Verhalten von sphinx.util.docfields.Field.make_field für die Verwendung des item-Arguments beeinträchtigte.

Dokumentation

• Erweiterte die Dokumentation zum Erstellen von Erweiterungen.

Release 1.2.1 (veröffentlicht 19. Januar 2014)

Behobene Fehler

• #1335: Korrigiert autosummary-Template-Überlagerung mit Ausrufezeichen-Präfix wie {% extends "!autosummary/class.rst" %}, was zu einem unendlichen rekursiven Funktionsaufruf führt. Dies wurde durch PR#181 verursacht.

• #1337: Korrigiert autodoc mit autoclass_content="both", der einen nutzlosen object.__init__-Docstring verwendet, wenn die Klasse keine __init__ hat. Dies wurde durch eine Änderung für #1138 verursacht.

• #1340: Alphabetische Wörter können in der HTML-Schnellsuche, die mit language=’ja’ generiert wird, nicht gefunden werden.

• #1319: Stürzt nicht ab, wenn die Datei html_logo nicht existiert.

• #603: Verwendet nicht den HTML-gestylten Titel für die Erstellung des Suchindex (was dazu führte, dass „literal“ auf jeder Seite mit einem Literal im Titel gefunden wurde).

• #751: Ermöglicht längere Produktionslisten als eine Seite in LaTeX durch die Verwendung von longtable.

• #764: Sucht immer nach Stoppwörtern in Kleinbuchstaben in der JS-Suche.

• #814: autodoc: Schutz vor seltsamen Objekttypen, die keine __bases__ haben.

• #932: autodoc: Stürzt nicht ab, wenn __doc__ keine Zeichenkette ist.

• #933: Stürzt nicht ab, wenn ein option-Wert fehlerhaft ist (enthält Leerzeichen, aber keinen Optionsnamen).

• #908: Unter Python 3, Fehlerbehandlung von Fehlermeldungen aus LaTeX in der pngmath-Erweiterung.

• #943: In autosummary werden „erste Sätze“ aus dem Docstring erkannt, wenn sie Großbuchstaben enthalten.

• #923: Berücksichtigt das gesamte LaTeX-Dokument beim Caching von mit pngmath generierten Bildern. Dies baut sie korrekt neu, wenn sich pngmath_latex_preamble ändert.

• #901: Gibt eine Warnung aus, wenn die neue „math“-Markup von Docutils ohne eine aktive Sphinx-Mathe-Erweiterung verwendet wird.

• #845: In Codeblöcken, wenn der ausgewählte Lexer fehlschlägt, werden Zeilennummern trotzdem angezeigt, wenn konfiguriert.

• #929: Unterstützt parsed-literal Blöcke in der LaTeX-Ausgabe korrekt.

• #949: Aktualisiert tabulary.sty, das mit Sphinx gebündelt ist.

• #1050: Fügt anonyme Labels zu objects.inv hinzu, um über intersphinx referenziert zu werden.

• #1095: Korrigiert das Druckmedien-Stylesheet, das immer im „scrolls“-Theme enthalten war.

• #1085: Korrigiert die Einstellung des aktuellen Klassennamens, wenn die Klassendeskription :noindex: gesetzt hat.

• #1181: Meldet Optionsfehler in autodoc-Direktiven gnädiger.

• #1155: Korrigiert die automatische Dokumentation von C-definierten Methoden als Attribute unter Python 3.

• #1233: Ermöglicht das Auffinden von Python-Klassen und -Ausnahmen mit den Rollen „class“ und „exc“ in intersphinx.

• #1198: Ermöglicht „image“ für die Option „figwidth“ der figure-Direktive, wie von docutils dokumentiert.

• #1152: Korrigiert pycode-Parsing-Fehler von Python 3-Code durch Einbeziehung zweier Grammatikversionen für Python 2 und 3 und Laden der entsprechenden Version für die laufende Python-Version.

• #1017: Hilft dem Benutzer und informiert ihn, wenn das Argument für option nicht dem erforderlichen Format entspricht.

• #1345: Korrigiert zwei Fehler mit nitpick_ignore; Sie müssen nun nicht mehr die Speicherumgebung entfernen, damit Änderungen wirksam werden.

• #1072: In der JS-Suche werden Probleme beim Suchen nach Großbuchstaben behoben, indem Wörter vor dem Stemming kleingeschrieben werden.

• #1299: Macht das Verhalten der math-Direktive konsistenter und vermeidet die Erzeugung leerer Umgebungen in der LaTeX-Ausgabe.

• #1308: Entfernt HTML-Tags aus dem Inhalt von „raw“-Knoten, bevor diese an den Suchindexer übergeben werden.

• #1249: Korrigiert doppelte LaTeX-Seitennummerierung für Handbuchdokumente.

• #1292: Im Linkchecker werden HEAD-Anfragen bei HTTP 405-Verweigerung erneut versucht. Macht auch den Weiterleitungscode ersichtlich und passt die Ausgabe etwas an, um sie deutlicher zu machen.

• #1285: Vermeidet Namenskonflikte zwischen C-Domänenobjekten und Abschnittstiteln.

• #848: Nimmt immer den neuesten Code in inkrementellen Wiederholungen mit der sphinx.ext.viewcode-Erweiterung.

• #979, #1266: Korrigiert die Ausnahmebehandlung in sphinx-apidoc.

• #1302: Korrigiert Regression in sphinx.ext.inheritance_diagram beim Dokumentieren von Klassen, die nicht gepickelt werden können.

• #1316: Entfernt festkodierte font-face-Ressourcen aus dem epub-Theme.

• #1329: Korrigiert Traceback mit leerem translation msgstr in .po-Dateien.

• #1300: Korrigiert, dass Referenzen in übersetzten Dokumenten in einigen Fällen nicht funktionieren.

• #1283: Korrigiert einen Fehler bei der Erkennung von geänderten Dateien, der versucht hätte, auf Doctrees gelöschter Dokumente zuzugreifen.

• #1330: Korrigiert das Verhalten von exclude_patterns mit Unterverzeichnissen in html_static_path.

• #1323: Korrigiert die Ausgabe leerer <ul>-Tags im HTML-Writer, was kein gültiges HTML ist.

• #1147: Gibt keine Seitenleisten-Suchbox im „singlehtml“-Builder aus.

Dokumentation

• #1325: Ein Tutorial-Abschnitt „Intersphinx“ wurde hinzugefügt. (doc/tutorial.rst)

Release 1.2 (veröffentlicht 10. Dezember 2013)

Hinzugefügte Funktionen

• Es wurde das Tupel sphinx.version_info für programmatische Überprüfungen der Sphinx-Version hinzugefügt.

Inkompatible Änderungen

• Die Erweiterung sphinx.ext.refcounting wurde entfernt – sie ist sehr spezifisch für CPython und hat keinen Platz in der Hauptdistribution.

Behobene Fehler

• Wiederherstellung der CSS-Klasse versionmodified für versionadded/changed und deprecated Direktiven.

• PR#181: Korrigiert, dass html_theme_path = ['.'] ein Auslöser für die ständige Wiederherstellung aller Dokumente ist (Diese Änderung behält die aktuelle Funktion „Theme-Änderungen lösen eine Wiederherstellung aus“ bei).

• #1296: Korrigiert ungültigen Zeichensatz in HTML-Hilfe-generierten HTML-Dateien für die Standard-Lokalisierung.

• PR#190: Korrigiert, dass gettext die Bildunterschrift und den Rubriktitel innerhalb anderer Blöcke nicht extrahiert. Dank an Michael Schlenker.

• PR#176: Stellt sicher, dass der setup_command-Test Sphinx immer importieren kann. Dank an Dmitry Shachnev.

• #1311: Korrigiert, dass test_linkcode.test_html mit C-Locale und Python 3 fehlschlägt.

• #1269: Korrigiert ResourceWarnings mit Python 3.2 oder neuer.

• #1138: Korrektur: Wenn autodoc_docstring_signature = True und autoclass_content = 'init' oder 'both', sollte die __init__-Zeile aus der Klassendokumentation entfernt werden.

Release 1.2 beta3 (veröffentlicht 3. Oktober 2013)

Hinzugefügte Funktionen

• Die Sphinx-Fehlerprotokolldateien enthalten nun eine Liste der geladenen Erweiterungen zur Fehlerbehebung.

Inkompatible Änderungen

• PR#154: Entfernt das Präfix „sphinx“ aus dem LaTeX-Klassennamen, außer bei ‚sphinxmanual‘ und ‚sphinxhowto‘. Nun können Sie Ihre benutzerdefinierte Dokumentationsklasse ohne das Präfix ‚sphinx‘ verwenden. Dank an Erik B.

Behobene Fehler

• #1265: i18n korrigieren: Absturz beim Übersetzen eines Abschnittsnamens, auf den von einem benannten Ziel verwiesen wird.

• Eine falsche Bedingung beeinträchtigte die Suchfunktion auf der ersten Seite, die normalerweise index.rst ist. Dieses Problem trat in 1.2b1 auf.

• #703: Wenn Sphinx Dateinamen mit Nicht-ASCII-Zeichen nicht dekodieren kann, fängt Sphinx nun UnicodeError ab und fährt fort, wenn möglich, anstatt die Ausnahme auszulösen.

Release 1.2 beta2 (veröffentlicht 17. September 2013)

Hinzugefügte Funktionen

• apidoc ignoriert nun standardmäßig „_private“-Module und verfügt über eine Option -P, um sie einzubeziehen.

• apidoc hat nun die Option, keine Überschriften für Pakete und Module zu generieren, falls der Modul-Docstring bereits eine reST-Überschrift enthält.

• PR#161: apidoc kann nun jedes Modul auf eine eigenständige Seite schreiben, anstatt alle Module eines Pakets auf einer Seite zu kombinieren.

• Builder: i18n-Ziel-Dokument neu erstellen, wenn der Katalog aktualisiert wird.

• Unterstützt die docutils.conf „writers“- und „html4css1 writer“-Abschnitte im HTML-Writer. Die LaTeX-, Manpage- und Texinfo-Writer unterstützen ebenfalls ihre jeweiligen „writers“-Abschnitte.

• Der neue Konfigurationswert html_extra_path ermöglicht die Angabe von Verzeichnissen mit Dateien, die direkt in das HTML-Ausgabeverzeichnis kopiert werden sollen.

• Autodoc-Direktiven für Moduldaten und Attribute unterstützen nun eine annotation-Option, sodass die Standardanzeige des Daten-/Attributwerts überschrieben werden kann.

• PR#136: Autodoc-Direktiven unterstützen nun eine Option imported-members, um Mitglieder einzuschließen, die aus verschiedenen Modulen importiert wurden.

• Neue Lokalisierungen: Mazedonisch, Singhalesisch, Indonesisch.

• Themenpaket-Sammlung über den setuptools-Plugin-Mechanismus.

Inkompatible Änderungen

• PR#144, #1182: Erzwingt den Zeitzonen-Offset auf LocalTimeZone für POT-Creation-Date, der vom gettext-Builder generiert wurde. Dank an masklinn und Jakub Wilk.

Behobene Fehler

• PR#132: jQuery-Version auf 1.8.3 aktualisiert.

• PR#141, #982: Vermeidet Absturz beim Schreiben von PNG-Dateien unter Python 3. Dank an Marcin Wojdyr.

• PR#145: Bei parallelen Builds verwirft Sphinx die zweite Dokumentendatei zum Schreiben. Dank an tychoish.

• PR#151: Einige Styling-Updates für Tabellen in LaTeX.

• PR#153: Der Konfigurationswert „extensions“ kann nun überschrieben werden.

• PR#155: Unterstützung für einige C++11-Funktionsqualifizierer hinzugefügt.

• Korrektur: „make gettext“ verursachte UnicodeDecodeError, wenn Vorlagen UTF-8-kodierte Zeichenketten enthielten.

• #828: Verwenden von inspect.getfullargspec(), um Funktionen mit schlüsselwortbasierten Argumenten unter Python 3 dokumentieren zu können.

• #1090: i18n korrigieren: mehrere Querverweise (term, ref, doc) in derselben Zeile geben denselben Link zurück.

• #1157: Kombination von „globaltoc.html“ und verstecktem toctree verursachte eine Ausnahme.

• #1159: Korrigiert falsche Generierung des Objektinventars für Python-Module und fügt einen Workaround in intersphinx hinzu, um die Handhabung betroffener Inventare zu korrigieren.

• #1160: Fehlende Zitatziele verursachten eine AssertionError.

• #1162, PR#139: Der singlehtml-Builder kopierte keine Bilder nach _images/.

• #1173: Abhängigkeiten von setup.py angepasst, da Jinja2 2.7 die Kompatibilität mit Python < 3.3 und Python < 2.6 eingestellt hat. Dank an Alexander Dupuy.

• #1185: Stürzt nicht ab, wenn ein Python-Modul eine falsche oder keine Kodierung deklariert und Nicht-ASCII-Zeichen enthalten sind.

• #1188: sphinx-quickstart löst UnicodeEncodeError aus, wenn „Project version“ Nicht-ASCII-Zeichen enthält.

• #1189: „Title underline is too short“ WARNUNG wird ausgegeben, wenn Vollbreiten-Zeichen für „Project name“ bei quickstart verwendet werden.

• #1190: Der TeX/texinfo/man-Dateiname der Ausgabe hat keinen Basisnamen (nur Erweiterung), wenn Nicht-ASCII-Zeichen im „Project name“ bei quickstart verwendet werden.

• #1192: Korrigiert Escaping-Problem für Hyperlinks im Manpage-Writer.

• #1193: i18n korrigieren: mehrere Link-Referenzen in derselben Zeile geben denselben Link zurück.

• #1176: i18n korrigieren: Fußnotenreferenznummer fehlt für automatisch nummerierte benannte Fußnoten und automatisch symbolisierte Fußnoten.

• PR#146,#1172: Korrigiert ZeroDivisionError bei parallelen Builds. Dank an tychoish.

• #1204: Korrigiert die falsche Generierung von Links zu lokalen intersphinx-Zielen.

• #1206: i18n korrigieren: gettext hat den Titel der admonition-Direktive nicht übersetzt.

• #1232: Sphinx generierte fehlerhafte ePub-Dateien unter Windows.

• #1259: Schützt den Debug-Ausgabeaufruf beim Auslösen von Ereignissen; um zu verhindern, dass die repr()-Implementierung beliebiger Objekte Build-Fehler verursacht.

• #1142: Korrigiert NFC/NFD-Normalisierungsproblem von rst-Dateinamen unter Mac OS X.

• #1234: Ignoriert Zeichenketten, die nur aus Leerzeichen bestehen.

Release 1.2 beta1 (veröffentlicht 31. März 2013)

Inkompatible Änderungen

• Entfernt sphinx.util.compat.directive_dwim() und sphinx.roles.xfileref_role(), die seit Version 1.0 veraltet waren.

• PR#122: Die in latex_additional_files angegebenen Dateien überschreiben nun TeX-Dateien, die von Sphinx enthalten sind, wie z.B. sphinx.sty.

• PR#124: Der Knoten, der von den Direktiven versionadded, versionchanged und deprecated generiert wird, enthält nun alle hinzugefügten Markup (wie „New in version X“) als Kindknoten, und es müssen keine zusätzlichen Texte von den Writern generiert werden.

• PR#99: Die seealso-Direktive generiert nun Admonition-Knoten anstelle des benutzerdefinierten seealso-Knotens.

Hinzugefügte Funktionen

• Markup

  • Die toctree-Direktive und die Vorlagenfunktion toctree() haben nun eine Option includehidden, die versteckte toctree-Einträge einschließt (Fehler #790 und #1047). Ein Fehler in der Option maxdepth für die Vorlagenfunktion toctree() wurde behoben (Fehler #1046).

  • PR#99: Vereinfacht seealso-Direktiven zu normalen Admonitions. Dies entfernt ihre ungewöhnlichen CSS-Klassen (admonition-see-also), den inkonsistenten LaTeX-Admonition-Titel („See Also“ anstelle von „See also“) und den fehlerhaften Einzug im Text-Builder.

• HTML-Builder

  • #783: Erstellt einen Link zum vollen Bild, wenn es mit Breite oder Höhe skaliert ist.

  • #1067: Verbessert die Reihenfolge der JavaScript-Suchergebnisse: Übereinstimmungen in Titeln kommen vor Übereinstimmungen im Volltext, und Objektergebnisse werden besser kategorisiert. Implementiert auch einen konfigurierbaren Such-Scorer.

  • #1053: Die HTML-Theme-Optionen „rightsidebar“ und „collapsiblesidebar“ funktionieren nun zusammen.

  • Aktualisierung auf jQuery 1.7.1 und Underscore.js 1.3.1.

• Texinfo-Builder

  • Ein „Index“-Knoten wird nicht mehr hinzugefügt, wenn keine Einträge vorhanden sind.

  • „deffn“-Kategorien werden nicht mehr großgeschrieben, wenn sie Großbuchstaben enthalten.

  • desc_annotation-Knoten werden nun gerendert.

  • strong- und emphasis-Knoten werden nun wie literals formatiert. Der Grund dafür ist, dass die Standard-Texinfo-Markup (*strong* und _emphasis_) zu verwirrenden Ergebnissen führte, da diese Konstrukte häufig für die Dokumentation von Parameternamen verwendet wurden.

  • Feldlisten-Formatierung wurde angepasst, um „Info-Feldlisten“ besser anzuzeigen.

  • system_message- und problematic-Knoten werden nun ähnlich wie im Text-Builder formatiert.

  • Die Konvertierung von Doppelbindestrichen in „en-dash“ und „em-dash“ wird in Optionsdirektionssignaturen nicht mehr durchgeführt.

  • @ref wird nun anstelle von @pxref für Querverweise verwendet, was verhindert, dass das Wort „see“ vor dem Link hinzugefügt wird (beeinträchtigt die Info-Ausgabe nicht).

  • Der Befehl @finalout wurde für eine bessere TeX-Ausgabe hinzugefügt.

  • transition-Knoten werden nun mit Unterstrichen („_“) anstelle von Sternchen („*“) formatiert.

  • Der Standardwert für paragraphindent wurde von 2 auf 0 geändert, was bedeutet, dass Absätze standardmäßig nicht mehr eingerückt werden.

  • #1110: Ein neuer Konfigurationswert texinfo_no_detailmenu wurde hinzugefügt, um zu steuern, ob ein @detailmenu im Menü des „Top“-Knotens hinzugefügt wird.

  • Detaillierte Menüs werden nicht mehr erstellt, außer für den „Top“-Knoten.

  • Ein Problem behoben, bei dem doppelte Domänenindizes zu ungültigen Ausgaben führten.

• LaTeX-Builder

  • PR#115: Fügt den Eintrag 'transition' in latex_elements hinzu, um anzupassen, wie Übergänge angezeigt werden. Dank an Jeff Klukas.

  • PR#114: Der LaTeX-Writer enthält nun standardmäßig das Paket „cmap“. Der Eintrag 'cmappkg' in latex_elements kann zur Steuerung verwendet werden. Dank an Dmitry Shachnev.

  • Der Eintrag 'fontpkg' in latex_elements hat nun standardmäßig '', wenn die language das kyrillische Skript verwendet. Vorgeschlagen von Dmitry Shachnev.

  • Die Konfigurationswerte latex_documents, texinfo_documents und man_pages werden auf Standardwerte basierend auf master_doc gesetzt, wenn sie nicht explizit in conf.py festgelegt sind. Zuvor, wenn diese Werte nicht festgelegt waren, wurde von den entsprechenden Buildern keine Ausgabe generiert.

• Internationalisierung

  • Hinzufügung von i18n-Fähigkeiten für benutzerdefinierte Vorlagen. Zum Beispiel: Die Sphinx-Referenzdokumentation im Verzeichnis doc bietet eine sphinx.pot-Datei mit Nachrichten-Strings aus doc/_templates/*.html bei Verwendung von make gettext.

  • PR#61,#703: Unterstützung für die Behandlung von Nicht-ASCII-Dateinamen hinzugefügt.

• Andere Builder

  • Hinzugefügt wurden die nativen XML- und Pseudo-XML-Builder von Docutils. Siehe XMLBuilder und PseudoXMLBuilder.

  • PR#45: Der Linkcheck-Builder überprüft nun die Existenz von #anchors.

  • PR#123, #1106: Fügt den Konfigurationswert epub_use_index hinzu. Falls vorhanden, wird dieser für den epub-Builder anstelle von html_use_index verwendet.

  • PR#126: Fügt den Konfigurationswert epub_tocscope hinzu. Die Einstellung steuert die Generierung des epub-Toc. Der Benutzer kann nun auch versteckte Toc-Einträge einschließen.

  • PR#112: Fügt den Konfigurationswert epub_show_urls hinzu.

• Erweiterungen

  • PR#52: Das Flag special_members für autodoc verhält sich nun wie members.

  • PR#47: Hinzugefügt wurde die sphinx.ext.linkcode-Erweiterung.

  • PR#25: In Vererbungdiagrammen ist die erste Zeile des Klassen-Docstrings nun der Tooltip für die Klasse.

• Befehlszeilenschnittstellen

  • PR#75: Option --follow-links zu sphinx-apidoc hinzugefügt.

  • #869: sphinx-build hat nun die Option -T zum Drucken des vollständigen Tracebacks nach einer unbehandelten Ausnahme.

  • sphinx-build unterstützt nun die standardmäßigen Optionen --help und --version.

  • sphinx-build gibt nun spezifischere Fehlermeldungen aus, wenn es mit ungültigen Optionen oder Argumenten aufgerufen wird.

  • sphinx-build verfügt nun über eine ausführliche Option -v, die für mehr Wirkung wiederholt werden kann. Ein einzelnes Vorkommen liefert eine etwas ausführlichere Ausgabe als üblich. Zwei oder mehr Vorkommen dieser Option liefern detailliertere Ausgaben, die für das Debugging nützlich sein können.

• Lokalisierungen

  • PR#74: Korrigiert einige russische Übersetzungen.

  • PR#54: Norwegische Bokmål-Übersetzung hinzugefügt.

  • PR#35: Slowakische Übersetzung hinzugefügt.

  • PR#28: Ungarische Übersetzung hinzugefügt.

  • #1113: Hebräische Lokalisierung hinzufügen.

  • #1097: Baskische Lokalisierung hinzufügen.

  • #1037: Tippfehler in polnischer Übersetzung korrigiert. Dank an Jakub Wilk.

  • #1012: Estnische Übersetzung aktualisiert.

• Optimierungen

  • Beschleunigt das Erstellen des Suchindexes durch Caching der Ergebnisse der Wort-Stemming-Routinen. Spart etwa 20 Sekunden beim Erstellen der Python-Dokumentation.

  • PR#108: Experimentelle Unterstützung für paralleles Bauen mit einer neuen Option sphinx-build -j hinzugefügt.

Dokumentation

• PR#88: Das „Sphinx Developer’s Guide“ (doc/devguide.rst) wurde hinzugefügt, das den grundlegenden Entwicklungsprozess des Sphinx-Projekts beschreibt.

• Ein detailliertes Dokument „Installing Sphinx“ (doc/install.rst) wurde hinzugefügt.

Behobene Fehler

• PR#124: Korrigiert, dass Absätze in versionmodified ignoriert werden, wenn sie keine hängenden Absätze haben. Korrigiert falsche HTML-Ausgabe (verschachtelte <p>-Tags). Korrigiert, dass versionmodified nicht übersetzbar ist. Dank an Nozomu Kaneko.

• PR#111: Berücksichtigt add_autodoc_attrgetter() auch, wenn inherited-members gesetzt ist. Dank an A. Jesse Jiryu Davis.

• PR#97: Korrigiert Fußnotenbehandlung in übersetzten Dokumenten.

• Korrigiert, dass der Text-Writer visit_legend für die Inhalte der figure-Direktive nicht verarbeitet.

• Korrigiert, dass der Text-Builder Breit-/Vollbreiten-Zeichen nicht berücksichtigt: Titel-Unterstreichungsbreite, Tabellenlayoutbreite und Zeilenumbruchbreite.

• Korrigiert führende Leerzeichen in LaTeX-Tabellenkopfzellen.

• #1132: Korrigiert LaTeX-Tabellenausgabe für Mehrzeilenzellen in der ersten Spalte.

• #1128: Korrigiert Unicode-Fehler beim Versuch, Zeitzeichenfolgen mit einer nicht standardmäßigen Locale zu formatieren.

• #1127: Korrigiert Traceback, wenn autodoc versucht, eine Nicht-Python-Datei zu tokenisieren.

• #1126: Korrigiert die Umwandlung von Doppelbindestrichen in en-dash an falschen Stellen, wie z.B. bei Befehlszeilenoptionen in LaTeX.

• #1123: Erlaubt Leerzeichen in Dateinamen, die an literalinclude übergeben werden.

• #1120: Hinzugefügte Verbesserungen bezüglich i18n für die Themes „basic“, „haiku“ und „scrolls“, die Sphinx integriert hat. Dank an Leonardo J. Caballero G.

• #1118: Aktualisierte spanische Übersetzung. Dank an Leonardo J. Caballero G.

• #1117: Handhabt .pyx-Dateien in sphinx-apidoc.

• #1112: Vermeidet doppelte Download-Dateien, wenn sie auf unterschiedliche Weise (absolut/relativ) aus Dokumenten referenziert werden.

• #1111: Korrigiert Fehler beim Auffinden von Großbuchstaben im Suchergebnis, wenn html_search_language ‚ja‘ ist. Dank an Tomo Saito.

• #1108: Der Text-Writer nummeriert nummerierte Listen mit nicht standardmäßigen Startwerten nun korrekt (basierend auf einem Patch von Ewan Edwards).

• #1102: Unterstützt Multi-Kontext „with“-Anweisungen in autodoc.

• #1090: Korrigiert, dass gettext Glossarbegriffe nicht extrahiert.

• #1074: Fügt die Umgebungsversionsinformationen zum generierten Suchindex hinzu, um Kompatibilitätsprobleme mit alten Builds zu vermeiden.

• #1070: Vermeidet Unpickling-Probleme beim Ausführen von Python 3 und wenn die gespeicherte Umgebung unter Python 2 erstellt wurde.

• #1069: Behoben, dass autodoc versucht, Signaturen von „partial“-Funktionen ohne Schlüsselwortargumente zu formatieren (Patch von Artur Gaspar).

• #1062: sphinx.ext.autodoc verwendet die __init__-Methodensignatur für die Klassensignatur.

• #1055: Korrigiert Web-Support mit relativem Pfad zum Quellverzeichnis.

• #1043: Korrigiert sphinx-quickstart, das erneut Ja/Nein-Fragen stellt, da input() Werte mit einem zusätzlichen ‚r‘ unter Python 3.2.0 + Windows zurückgibt. Dank an Régis Décamps.

• #1041: Korrigiert das Fehlschlagen des cpp-Domänen-Parsers beim Parsen eines const-Typs mit einem Modifier.

• #1038: Korrigiert das Fehlschlagen des cpp-Domänen-Parsers beim Parsen von C+11 „static constexpr“-Deklarationen. Dank an Jakub Wilk.

• #1029: Korrigiert, dass intersphinx_mapping-Werte nicht stabil sind, wenn die Zuordnung mehrere Schlüssel/Werte mit Python 3.3 hat.

• #1028: Korrigiert Zeilenblockausgabe im Text-Writer.

• #1024: Verbessert die Makefile/make.bat-Fehlermeldung, wenn Sphinx nicht gefunden wird. Dank an Anatoly Techtonik.

• #1018: Korrigiert die Handhabung der „container“-Direktive im Text-Writer.

• #1015: Stoppt das Überschreiben von jQuery contains() in JavaScript.

• #1010: Macht pngmath-Bilder standardmäßig transparent; IE7+ sollte dies unterstützen.

• #1008: Korrigiert Testfehler mit Python 3.3.

• #995: Korrigiert Inhaltsverzeichnis und Seitennummerierung für die LaTeX-Klasse „howto“.

• #976: Korrigiert, dass gettext keine Indexeinträge extrahiert.

• PR#72: #975: Korrigiert, dass gettext keine Definitionsbegriffe vor Docutils 0.10 extrahiert.

• #961: Korrigiert LaTeX-Ausgabe für dreifache Anführungszeichen in Code-Snippets.

• #958: Behält environment.pickle nach einem fehlgeschlagenen Build nicht bei.

• #955: Korrigiert i18n-Transformation.

• #940: Korrigiert, dass gettext keine Bildunterschrift extrahiert.

• #920: Korrigiert PIL-Packaging-Problem, das den Import von Image ohne PIL-Namensraum ermöglichte. Dank an Marc Schlaich.

• #723: Korrigiert die Suchfunktion für lokale Dateien in WebKit-basierten Browsern.

• #440: Behebung der groben Zeitstempelauflösung in einigen Dateisystemen, die eine falsche Liste veralteter Dateien generiert.

Vorherige

Sphinx 1.3

Nächste

Sphinx 1.1