Sphinx 1.5¶

Version 1.5.6 (veröffentlicht am 15. Mai 2017)¶

Behobene Fehler¶

#3614: Sphinx stürzt mit requests-2.5.0 ab
#3618: autodoc stürzt mit tupel-Argumenten ab
#3664: Kein Leerzeichen nach dem Aufzählungspunkt in Elementen einer von Sphinx erzeugten LaTeX-Liste
#3657: EPUB-Builder stürzt ab, wenn ein Dokument mit Genindex existiert
#3588: Keine kompakte (p-Tag) HTML-Ausgabe im i18n-Dokumenten-Build, auch wenn html_compact_lists True ist.
#3685: AttributeError bei Verwendung von 3rd-Party-Domains
#3702: LaTeX-Writer formatiert Abbildungsunterschriften mit einem fest kodierten \small
#3708: LaTeX-Writer erlaubt das irc-Schema
#3717: Keine Erzwingung mehr, dass Favicons .ico sein müssen
#3731, #3732: Schützt die isenumclass-Prädikatsfunktion gegen nicht-klassenargumente
#3320: Warnung über nicht gefundenes Referenzziel für Containertypen
Falsch geschriebenes ARCHIVEPREFIX in Makefile für LaTeX-Build-Repertory

Version 1.5.5 (veröffentlicht am 03. April 2017)¶

Behobene Fehler¶

#3597: Python-Domain löst UnboundLocalError aus, wenn ein ungültiger Name angegeben wird
#3599: Umstellung auf neues MathJax CDN

Version 1.5.4 (veröffentlicht am 02. April 2017)¶

Hinzugefügte Funktionen¶

#3470: Genindex unterstützt jetzt alle Arten von Buchstaben, nicht nur lateinische

Behobene Fehler¶

#3445: Die Einstellung des Schlüssels 'inputenc' auf \\usepackage[utf8x]{inputenc} führt zu einem fehlerhaften PDF-Build
EPUB-Datei hat einen doppelten nav.xhtml-Link in content.opf, außer beim ersten Build
#3488: objects.inv ist defekt, wenn release oder version einen Rückgabecode enthalten
#2073, #3443, #3490: gettext-Builder, der pot-Dateien schreibt, es sei denn, der Inhalt ist ohne Erstellungsdatum gleich. Dank an Yoshiki Shibukawa.
#3487: intersphinx: Konnte Optionen nicht referenzieren
#3496: Die letzte Spalte von latex longtable kann viel breiter sein als ihr Inhalt
#3507: Falsche Anführungszeichen in der LaTeX-Ausgabe für die directives productionlist
#3533: Der Wechsel von Sphinx 1.3.1 zu 1.5.3 bricht die LaTeX-Kompilierung von Links, die als Code gerendert werden
#2665, #2607: Linknamen in C++-Docfields und Möglichkeit für andere Domains.
#3542: C++, Fehler beim Parsen von nicht-Typ-Template-Argumenten mit Template behoben.
#3065, #3520: Python-Domain erkennt verschachtelte Klassen nicht
#3575: Probleme mit pdflatex in einem türkischen Dokument, das mit Sphinx erstellt wurde, sind wieder aufgetreten (siehe #2997, #2397)
#3577: Debug-Tool für Intersphinx behoben
Ein LaTeX-Befehl wie \large, der in die Titel-Elemente von latex_documents eingefügt wird, verursacht einen fehlgeschlagenen PDF-Build (siehe #3551, #3567)

Version 1.5.3 (veröffentlicht am 26. Februar 2017)¶

Hinzugefügte Funktionen¶

Unterstützung für requests-2.0.0 (experimentell) (siehe: #3367)
(LaTeX) PDF-Seitenrandabmessungen können angepasst werden (siehe: #3387)
Die literalinclude-Direktive erlaubt die Kombination der Optionen :pyobject: und :lines: (siehe: #3416)
#3400: make-Mode verwendet beim Erstellen von Dokumenten keinen Subprozess

Behobene Fehler¶

#3370: Die Bildunterschrift von code-block wird nicht zur Übersetzung übernommen
LaTeX: release wird nicht escaped (siehe: #3362)
#3364: sphinx-quickstart-Eingabeaufforderungen überlaufen auf der Konsole mit 80 Zeichen Breite
Seit 1.5 fehlen im PDF-Inhaltsverzeichnis und in den Lesezeichen Einträge für den allgemeinen Index (siehe: #3383)
#3392: 'releasename' in latex_elements funktioniert nicht
#3356: Seitenlayout für die japanische 'manual'-Dokumentenklasse hat einen kürzeren Textbereich
#3394: Wenn 'pointsize' nicht 10pt ist, erhält die japanische 'manual'-Dokumentation falsche PDF-Seitenabmessungen
#3399: quickstart: conf.py wurde nicht durch die Vorlage überschrieben
#3366: Die Option-Direktive erlaubt keine Satzzeichen
#3410: Rückgabecode in release bricht die HTML-Suche
#3427: autodoc: Speicheradressen werden unter Windows nicht gestrippt
#3428: xetex-Build-Tests schlagen fehl aufgrund von fontspec v2.6, das \strong definiert
#3349: Das Ergebnis von IndexBuilder.load() ist defekt
#3450: &nbsp erscheint in EPUB-Dokumenten
#3418: Suchschaltfläche ist in den Themes Nature und Pyramid falsch ausgerichtet
#3421: Bildunterschriften von Tabellen konnten nicht übersetzt werden
#3552: linkcheck löst UnboundLocalError aus

Version 1.5.2 (veröffentlicht am 22. Januar 2017)¶

Inkompatible Änderungen¶

Aktualisierte Abhängigkeitsanforderungen: requests 2.4.0 oder höher (siehe: #3268, #3310)

Hinzugefügte Funktionen¶

#3241: gibt LaTeX-Warnung aus, wenn titlesec fehlerhaft ist (siehe #3210)
#3194: Verweist auf die Umgebungsvariable $MAKE, um den make-Befehl zu bestimmen
Gibt Warnung für verschachtelte nummerierte Toctrees aus (siehe: #3142)
#978: intersphinx_mapping erlaubt auch eine Liste als Parameter
#3340: (LaTeX) Lange Zeilen in parsed-literal werden wie in der code-block-Direktive umgebrochen, Inline-Mathematik und Fußnoten sind voll funktionsfähig.

Behobene Fehler¶

#3246: xapian-Suchadapter stürzt ab
#3253: In einer Py2-Umgebung erzeugt das Erstellen einer anderen Sprache mit einem nicht-beschrifteten Toctree None-Bildunterschriften
#185: Referenzen auf Abschnittsüberschriften mit rohen Knoten sind defekt
#3255: In einer Py3.4-Umgebung unterstützt autodoc die Dokumentation von Attributen der Enum-Klasse nicht korrekt.
#3261: latex_use_parts lässt Sphinx abstürzen
Der Warnungstyp misc.highlighting_failure funktioniert nicht
#3294: add_latex_package() verursacht Abstürze bei Nicht-LaTeX-Buildern
Die Bildunterschriften von Tabellen werden als ungültiges HTML gerendert (siehe: #3287)
#3268: Sphinx stürzt mit dem requests-Paket von Debian Jessie ab
#3284: Sphinx stürzt beim parallelen Build mit einer Erweiterung ab, die eine nicht serialisierbare Ausnahme auslöst
#3315: Bibliografie stürzt beim LaTeX-Build mit der Dokumentenklasse „memoir“ ab
#3328: Rubrik konnte nicht implizit referenziert werden
#3329: Gibt Warnungen aus, wenn eine po-Datei ungültig ist und nicht gelesen werden kann. Schreibt auch mo.
#3337: Schlechte Darstellung des Klassifikators von Definitionlisten-Begriffen
#3335: gettext extrahiert nicht den Feldnamen eines Feldes in einer Feldliste
#2952: C++, Korrigierte Referenzen auf Operator()-Funktionen.
Behob Unicode-Super- und -Subskriptziffern in der LaTeX-Ausgabe von code-block und parsed-literal (siehe #3342)
LaTeX-Writer: lässt das "-Zeichen innerhalb von parsed-literal unverändert (siehe #3341)
#3234: intersphinx schlug bei kodierten Inventaren fehl
#3158: zu viel Platz nach Bildunterschriften in der PDF-Ausgabe
#3317: Eine URL in parsed-literal-Inhalten wird in PDF falsch gerendert, wenn ein Bindestrich vorhanden ist
LaTeX stürzt ab, wenn der Dateiname eines Bildes, das über eine Substitution in parsed-literal eingefügt wird, einen Bindestrich enthält (siehe #3340)
LaTeX-Rendering von eingefügten Fußnoten in parsed-literal ist falsch (siehe #3340)
Inline-Mathematik in parsed-literal wird von LaTeX nicht gut gerendert (siehe #3340)
#3308: Parsed-Literale brechen sehr lange Zeilen mit dem PDF-Builder nicht um (siehe #3340)
#3295: Konnte die Erweiterung sphinx.builders.linkcheck nicht importieren
#3285: autosummary: Sternchen werden doppelt escaped
LaTeX, übergibt die dvipdfm-Option an das geometry-Paket für japanische Dokumente (siehe #3363)
Fix parselinenos() konnte den links halb geöffneten Bereich nicht parsen (vgl. „-4“)

Version 1.5.1 (veröffentlicht am 13. Dezember 2016)¶

Hinzugefügte Funktionen¶

#3214: Ermöglicht die Unterdrückung von Warnungen wegen „unbekannter Mimetype“ vom EPUB-Builder mit suppress_warnings.

Behobene Fehler¶

#3195: Kann nicht parallel erstellen
#3198: AttributeError wird ausgelöst, wenn toctree „self“ hat
#3211: Entfernt unübersetzte Sphinx-Locale-Kataloge (war abgedeckt durch unübersetzte it_IT)
#3212: HTML-Builder stürzen mit Docutils 0.13 ab
#3207: Weitere LaTeX-Probleme mit Referenzen innerhalb der parsed-literal-Direktive (\DUrole)
#3205: sphinx.util.requests stürzt mit altem pyOpenSSL (< 0.14) ab
#3220: KeyError bei doppelter Zitation
#3200: LaTeX: xref innerhalb von desc_name nicht erlaubt
#3228: Der Befehl build_sphinx stürzt ab, wenn eine Abhängigkeit fehlt
#2469: Ignoriert Updates von Katalogdateien für den gettext-Builder. Dank an Hiroshi Ohkubo.
#3183: Zufällige Reihenfolge der Sprungboxen auf der generierten Indexseite.

Version 1.5 (veröffentlicht am 05. Dezember 2016)¶

Inkompatible Änderungen¶

1.5a1

LaTeX, das Paket fancybox ist keine Abhängigkeit mehr von sphinx.sty
Verwendet 'locales' als Standardwert für locale_dirs
LaTeX, das Paket ifthen wird nicht mehr verwendet (und nicht mehr enthalten) von sphinx.sty
LaTeX, die Stil-Datei modifiziert nicht fancyvrb’s Verbatim (auch als OriginalVerbatim verfügbar), sondern verwendet sphinxVerbatim für den Namen des benutzerdefinierten Wrappers.
LaTeX, das Paket newfloat wird nicht mehr verwendet (und nicht mehr enthalten) (siehe #2660; es wurde seit 1.3.4 verwendet und seit 1.4 mit Sphinx ausgeliefert).
LaTeX, Literalblöcke in Tabellen verwenden nicht OriginalVerbatim, sondern sphinxVerbatimintable, das Bildunterschriften handhabt und Zeilen umbricht (siehe #2704).
LaTeX, ersetzt pt durch das TeX-Äquivalent bp, wenn es im Attribut width oder height eines Bildes gefunden wird.
LaTeX, wenn das Attribut width oder height eines Bildes ohne Einheit angegeben ist, wird px anstelle von Ignorieren verwendet.
LaTeX: Trennt Stylesheets von Pygments in eine eigenständige .sty-Datei
#2454: Der Dateiname von sourcelink wird jetzt geändert. Der Wert von html_sourcelink_suffix wird an den ursprünglichen Dateinamen angehängt (wie index.rst.txt).
sphinx.util.copy_static_entry() ist jetzt veraltet. Verwenden Sie stattdessen sphinx.util.fileutil.copy_asset().
sphinx.util.osutil.filecopy() überspringt das Kopieren, wenn die Datei nicht geändert wurde (siehe: #2510, #2753)
Unterstützung für Internet Explorer 6-8, Opera 12.1x oder Safari 5.1+ wird fallen gelassen, da die jQuery-Version von 1.11.0 auf 3.1.0 aktualisiert wurde (siehe: #2634, #2773)
QtHelpBuilder generiert keine Suchseite (siehe: #2352)
QtHelpBuilder verwendet das nonav-Theme anstelle des Standard-Themes, um die Lesbarkeit zu verbessern.
LaTeX: Um gute Standardeinstellungen für japanische Dokumente bereitzustellen, verwendet Sphinx jreport und jsbook als Dokumentenklasse, wenn language ja ist.
sphinx-quickstart erlaubt jetzt, dass die Projektversion leer ist
Behob :download:-Rolle auf epub/qthelp-Builder. Sie ignorieren die Rolle, da sie diese nicht unterstützen.
sphinx.ext.viewcode funktioniert standardmäßig nicht beim EPUB-Build. Option viewcode_enable_epub
sphinx.ext.viewcode ist im Singlehtml-Builder deaktiviert.
Verwendet den make-Mode von sphinx-quickstart standardmäßig. Um dies zu deaktivieren, verwenden Sie die Option -M.
Behob den Link-Adressen von genindex.html, der Dokumentenvorlage von Sphinx, um den XHTML-Standard zu erfüllen.
Verwendet den epub3-Builder standardmäßig. Und der alte epub-Builder wurde in epub2 umbenannt.
Behob epub- und epub3-Builder, die Links zu genindex enthielten, auch wenn epub_use_index = False.
html_translator_class ist jetzt veraltet. Verwenden Sie stattdessen die set_translator() API.
Unterstützung für Python 2.6 und 3.3 eingestellt
Option epub3_page_progression_direction des epub3-Builders fallen gelassen (verwenden Sie epub3_writing_mode).
#2877: Benennt latex_elements['footer'] in latex_elements['atendofbody'] um

1.5a2

#2983: Benennt epub3_description und epub3_contributor in epub_description und epub_contributor um.
Entfernt themes/basic/defindex.html; wird nicht mehr verwendet
Sphinx liefert die LaTeX-Stildatei fncychap nicht mehr aus (verwendet sie aber weiterhin)
#2435: Schnelleres quickstarted conf.py
Das LaTeX-Paket sphinx.sty lädt „hyperref“ nicht mehr selbst, da dies später im Präambel der LaTeX-Ausgabe über den 'hyperref'-Schlüssel erfolgt.
Sphinx liefert keine benutzerdefinierte modifizierte LaTeX-Stildatei tabulary mehr aus. Das unveränderte Paket wird verwendet.
#3057: Standardmäßig werden Fußnotenmarkierungen in der LaTeX-PDF-Ausgabe nicht mehr durch ein Leerzeichen eingeleitet. \sphinxBeforeFootnote ermöglicht bei Bedarf eine benutzerdefinierte Anpassung.
LaTeX-Ziel erfordert, dass die Option hyperfootnotes des Pakets hyperref unverändert auf ihrem Standardwert (d. h. true) belassen wird (siehe: #3022)

1.5 final

#2986: themes/basic/defindex.html ist jetzt veraltet
Gibt Warnungen aus, die in Sphinx 1.6 veraltet sein werden, standardmäßig. Benutzer können das Verhalten ändern, indem sie die Umgebungsvariable PYTHONWARNINGS setzen. Bitte siehe Veraltete Warnungen.
#2454: Neue JavaScript-Variable SOURCELINK_SUFFIX wird hinzugefügt

Veraltet¶

Diese Funktionen werden in Sphinx 1.6 entfernt

LDML-Formatunterstützung in der i18n-Funktion
sphinx.addnodes.termsep
Einige Funktionen und Klassen in sphinx.util.pycompat: zip_longest, product, all, any, next, open, class_types, base_exception, relpath, StringIO, BytesIO. Bitte verwenden Sie stattdessen die Version aus der Standardbibliothek.

Wenn Veraltungswarnungen wie RemovedInSphinxXXXWarning angezeigt werden, siehe Veraltete Warnungen.

Hinzugefügte Funktionen¶

1.5a1

#2951: Hinzufügen von --implicit-namespaces PEP-0420-Unterstützung zu apidoc.
Hinzufügen der Option :caption: für sphinx.ext.inheritance_diagram.
#2471: Hinzufügen einer Konfigurationsvariable für Standard-Doctest-Flags.
Konvertierung des Linkcheck-Builders zu requests für bessere Zeichenkodierungsbehandlung
#2463, #2516: Hinzufügen von Schlüsselwörtern der „meta“-Direktive zum Suchindex
Die :maxdepth:-Option von toctree beeinflusst secnumdepth (siehe: #2547)
#2575: Jetzt erlaubt sphinx.ext.graphviz die :align:-Option
Anzeigen von Warnungen, wenn ein unbekannter Schlüssel in latex_elements angegeben wird
Anzeigen von Warnungen, wenn keine Domains mit primary_domain übereinstimmen (siehe: #2001)
C++, Anzeigen von Warnungen, wenn die Art der Rolle irreführend für die Art des von ihr referenzierten Ziels ist (z. B. die Rolle class für eine Funktion).
LaTeX, Writer abstrahiert mehr Textformatierung in anpassbare Makros, z. B. gibt visit_emphasis \sphinxstyleemphasis anstelle von \emph aus (was woanders oder in einem hinzugefügten LaTeX-Paket in Gebrauch sein könnte). Siehe Liste am Ende von sphinx.sty (siehe: #2686)
LaTeX, öffentliche Namen für Umgebungen und Parameter, die von note, warning und anderen Admonition-Typen verwendet werden, was eine vollständige Anpassbarkeit durch den Schlüssel 'preamble' oder eine Eingabedatei ermöglicht (siehe: Feature-Anfrage #2674, #2685)
LaTeX, bessere Berechnung der Spaltenbreiten einiger Tabellen (als Ergebnis gibt es geringfügige Änderungen, da Tabellen jetzt korrekt die Zeilenbreite ausfüllen; siehe: #2708)
LaTeX, die Umgebung sphinxVerbatim ist einfacher anzupassen (siehe: #2704). Zusätzlich zu den bereits vorhandenen VerbatimColor und VerbatimBorderColor
- zwei Längen \sphinxverbatimsep und \sphinxverbatimborder,
- Boolesche Werte \ifsphinxverbatimwithframe und \ifsphinxverbatimwrapslines.
LaTeX, Bildunterschriften für Literalblöcke in Tabellen werden behandelt, und lange Codezeilen werden umgebrochen, um in die Tabellenzelle zu passen (siehe: #2704)
#2597: Warnmeldungen in Dunkelrot anzeigen
LaTeX, erlaubt Bildabmessungen mit px-Einheit (Standard ist 96px=1in)
Warnungen anzeigen, wenn ungültige Einheiten für Abmessungen gefunden werden
#2650: Hinzufügen der Option --pdb zum setup.py-Befehl
LaTeX, macht die Verwendung von \small für Code-Listings anpassbar (siehe #2721)
#2663: Hinzufügen der Option --warning-is-error zum setup.py-Befehl
Warnungen anzeigen, wenn veraltete LaTeX-Optionen verwendet werden
Hinzufügen von sphinx.config.ENUM zur Überprüfung, ob die Konfigurationswerte in Kandidaten enthalten sind
Mathematik: Hinzufügen eines Hyperlink-Markers zu jeder Gleichung in der HTML-Ausgabe
Hinzufügen eines neuen Themes nonav, das keine Navigationslinks enthält. Dies ist für jeden Hilfe-Generator wie qthelp.
#2680: sphinx.ext.todo gibt jetzt Warnungen aus, wenn todo_emit_warnings aktiviert ist. Außerdem gibt es ein zusätzliches Ereignis namens todo-defined aus, um TODO-Einträge in 3rd-Party-Erweiterungen zu verarbeiten.
Der Signatur-Parser der Python-Domain verwendet jetzt den xref-Mixin für „exceptions“, wodurch Ausnahmeklassen automatisch verknüpft werden können.
#2513: Hinzufügen von latex_engine zum Umschalten der LaTeX-Engine per conf.py
#2682: C++, grundlegende Unterstützung für Attribute (C++11-Stil und GNU-Stil). Die neuen Konfigurationsvariablen „cpp_id_attributes“ und „cpp_paren_attributes“ können zur Einführung benutzerdefinierter Attribute verwendet werden.
#1958: C++, Hinzufügen der Konfigurationsvariable „cpp_index_common_prefix“ zum Entfernen von Präfixen aus dem Indextext von C++-Objekten.
C++, hinzugefügte Konzept-Direktive. Dank an mickk-on-cpp.
C++, hinzugefügte Unterstützung für die Template-Einführungssyntax. Dank an mickk-on-cpp.
#2725: LaTeX-Builder: Erlaubt die Verwendung einer benutzerdefinierten Vorlagendatei (experimentell)
apidoc vermeidet jetzt die Invalidierung von Cache-Dateien, indem es nicht in Dateien schreibt, deren Inhalt sich nicht ändert. Dies kann zu signifikanten Leistungssteigerungen führen, wenn apidoc häufig ausgeführt wird.
#2851: sphinx.ext.math löst das missing-reference-Ereignis aus, wenn die Gleichung nicht gefunden wird
#1210: Die Rolle eqref unterstützt jetzt Querverweise
#2892: Hinzufügen der Option -a (--append-syspath) zu sphinx-apidoc
#1604: epub3-Builder: Beachtet schriftartbezogene CSS bei der Anzeige in iBooks.
#646: Die option-Direktive unterstützt das „.“-Zeichen als Teil von Optionen
Dokumentation zu Kindlegen hinzugefügt und Dokumentenstruktur dafür korrigiert.
#2474: Hinzufügen der Option intersphinx_timeout zu sphinx.ext.intersphinx
#2926: EPUB3-Builder unterstützt vertikalen Modus (Option epub3_writing_mode)
#2695: Das Unterkommando build_sphinx für setuptools behandelt Ausnahmen genauso wie sphinx-build
#326: Die Rolle numref kann auch auf Abschnitte verweisen
#2916: Die Rolle numref kann auch eine Bildunterschrift als Linktext referenzieren

1.5a2

#3008: Linkcheck-Builder ignoriert selbstsignierte Zertifikat-URLs
#3020: Neuer Schlüssel 'geometry' für latex_elements, dessen Standardwert die LaTeX-Stildatei geometry.sty verwendet, um das Seitenlayout festzulegen
#2843: Hinzufügen der Optionen :start-at: und :end-at: zur literalinclude-Direktive
#2527: Hinzufügen der Option :reversed: zur toctree-Direktive
Hinzufügen der Optionen -t und -d zu sphinx-quickstart zur Unterstützung der Templatisierung von generierten Sphinx-Projekten.
#3028: Hinzufügen von {path} und {basename} zum Format von figure_language_filename
Neuer Schlüssel 'hyperref' im Wörterbuch latex_elements (siehe #3030)
#3022: Erlaubt Codeblöcke in Fußnoten für die LaTeX-PDF-Ausgabe

1.5b1

#2513: Bessere Standardeinstellungen für XeLaTeX
#3096: Schlüssel 'maxlistdepth' zur Umgehung von LaTeX-Listenbeschränkungen
#3060: Autodoc unterstützt die Dokumentation von Attributen der Enum-Klasse. Jetzt rendert Autodoc nur den Wert von Enum-Attributen anstelle der Enum-Attributdarstellung.
Hinzufügen von --extensions zu sphinx-quickstart zur Unterstützung der Aktivierung beliebiger Erweiterungen über die Befehlszeile (siehe: #2904)
#3104, #3122: 'sphinxsetup' für Key=Value-Styling von Sphinx LaTeX
#3071: Autodoc: Erlaubt gemockten Modul-Dekoratoren, Funktionen unverändert durchzulassen
#2495: linkcheck: Erlaubt das Überspringen der Ankerprüfung mittels linkcheck_anchors_ignore
#3083: Unicode-Leerzeichen ohne Umbruch verhält sich wie LaTeX ~ (behoben #3019)
#3116: Erlaubt Zeilenumbruch in PDF-Ausgabe für Inline-Literale (siehe #3110)
#930: sphinx-apidoc erlaubt Wildcards für den Ausschluss von Pfaden. Dank an Nick Coghlan.
#3121: Hinzufügen der Option inlineliteralwraps zur Steuerung, ob Inline-Literale im PDF-Text umgebrochen werden

1.5 final

#3095: Hinzufügen von tls_verify und tls_cacerts zur Unterstützung von selbstsignierten HTTPS-Servern in linkcheck und intersphinx
#2215: make.bat, generiert von sphinx-quickstart, kann von einem anderen Verzeichnis aufgerufen werden. Dank an Timotheus Kampik.
#3185: Hinzufügen des neuen Warnungstyps misc.highlighting_failure

Behobene Fehler¶

1.5a1

#2707: (LaTeX) Die Spaltenbreite wird für Tabellen schlecht berechnet
#2799: Sphinx installiert Rollen und Direktiven automatisch beim Importieren des sphinx-Moduls. Jetzt installiert Sphinx sie beim Ausführen der Anwendung.
sphinx.ext.autodoc stürzt ab, wenn der Zielcode über autodoc_mock_imports * aus Mock-Modulen importiert.
#1953: Sphinx.add_node fügt keine Handler für den von html_translator_class installierten Übersetzer hinzu
#1797: Text-Builder fügt oben eine Leerzeile ein
#2894: quickstart main() verwendet kein argv-Argument
#2874: gettext-Builder konnte nicht den gesamten Text unter den only-Direktiven extrahieren
#2485: autosummary stürzt mit mehreren source_suffix-Werten ab
#1734: Bildunterschrift der toctree-Direktive konnte nicht übersetzt werden
Inhalt der meta-Direktive konnte nicht übersetzt werden (siehe: #1734)
#2550: Externe Links werden im Hilfe-Viewer geöffnet
#2687: Mehrmaliges Ausführen von Sphinx erzeugt Warnungen wegen „bereits registriert“

1.5a2

#2810: Probleme mit pdflatex in einem italienischen Dokument
Verwendet latex_elements.papersize, um die Papiergröße von LaTeX im Makefile anzugeben
#2988: linkcheck: Wiederholungsversuch mit GET-Anfrage, wenn HEAD-Anfrage abgelehnt wurde
#2990: linkcheck löst den Fehler „Can’t convert ‘bytes’ object to str implicitly“ aus, wenn linkcheck_anchors aktiviert ist
#3004: Ungültige Linktypen „top“ und „up“ werden verwendet
#3009: Schlechte Darstellung von parsed-Literalen in LaTeX seit Sphinx 1.4.4
#3000: Die option-Direktive generiert ungültige HTML-Anker
#2984: Ungültiges HTML wurde generiert, wenn html_split_index aktiviert ist
#2986: themes/basic/defindex.html sollte für HTML5 freundlicher gestaltet werden
#2987: Ungültiges HTML wurde generiert, wenn mehreren Listen IDs zugewiesen wurden
#2891: HTML-Suche liefert nicht alle Ergebnisse
#1986: Titel in PDF-Ausgabe
#147: Problem mit LaTeX-Kapitelstil
#3018: LaTeX-Problem mit Seitenlayout-Abmessungen und Kapiteltiteln
Behebung eines Problems mit \pysigline in der LaTeX-Stildatei (siehe #3023)
#3038: sphinx.ext.math* löst TypeError aus, wenn Labels doppelt sind
#3031: Inkompatibilität mit dem LaTeX-Paket tocloft
#3003: Literalblöcke in Fußnoten werden von LaTeX nicht unterstützt
#3047: Abstand vor Fußnote in PDF-Ausgabe ist inkohärent und erlaubt Zeilenumbrüche
#3045: HTML-Suchindex-Ersteller soll "rohe" Inhalte ignorieren, wenn kein HTML vorhanden ist
#3039: Englischer Stemmer gibt falsches Wort zurück, wenn das Wort großgeschrieben ist
Makefile-Vorlage für make-Mode korrigieren (ref #3056, #2936)

1.5b1

#2432: Unerwünschtes * zwischen Varargs und Keyword-Only-Argumenten korrigieren. Dank an Alex Grönholm.
#3062: PDF-Erstellung schlägt mit 1.5a2 fehl (undefiniertes \hypersetup für japanische Dokumente seit PR#3030)
Bessere Darstellung von mehrzeiligen Signaturen in HTML.
#777: LaTeX-Ausgabe "zu tief verschachtelt" (ref #3096)
LaTeX-Bildinklusion soll scale vor textwidth fit beachten (ref #2865, #3059)
#3019: LaTeX schlägt bei Beschreibung einer C-Funktion mit Argumenten fehl (ref #3083)
LaTeX-Inline-Literale korrigieren, bei denen < > - ein Leerzeichen verschluckten

1.5 final

#3069: Auch wenn der 'babel'-Schlüssel auf einen leeren String gesetzt ist, enthält die LaTeX-Ausgabe ein \addto\captions...
#3123: Die Benutzereinstellung des 'babel'-Schlüssels wird nicht mehr beachtet
#3155: JavaScript für html_sourcelink_suffix schlägt mit IE und Opera fehl
#3085: Aktuelles Verzeichnis nach Abbruch der Dokumentationserstellung beibehalten. Dank an Timotheus Kampik.
#3181: pLaTeX stürzt ab, wenn ein Abschnitt einen Gedankenstrich enthält
#3180: latex: Stretch/Shrink zwischen aufeinanderfolgenden ein- oder mehrzeiligen C++-Signaturen hinzufügen (ref #3072)
#3128: Globbing von Bildern unterstützt keine .svgz-Dateien
#3015: Ein fehlerhafter Test unter Windows korrigieren.
#1843: Dokumentation von Deskriptor-Klassen mit benutzerdefiniertem Metaklassen korrigieren. Dank an Erik Bray.
#3190: util.split_docinfo kann mehrzeilige Feldkörper nicht parsen
#3024, #3037: In Python3 stürzt application.Sphinx._log ab, wenn die Log-Nachricht nicht in die Konsolenkodierung kodiert werden kann.

Tests¶

Zur Vereinfachung verwendet Sphinx externe Mock-Pakete, auch wenn unittest.mock vorhanden ist.