Sphinx 3.5

Release 3.5.4 (veröffentlicht am 11. Apr 2021)

Abhängigkeiten

  • #9071: Docutils auf 0.16 beschränken

Behobene Fehler

  • #9078: autodoc: Asynchrone statische Methoden und Klassenmethoden werden mit Python3.10 als nicht-asynchrone Coroutine-Funktionen betrachtet

  • #8870, #9001, #9051: html-Theme: Die Stile werden mit Docutils 0.17 nicht angewendet

    • toctree-Bildunterschriften

    • Der Inhalt der Direktive sidebar

    • Abbildungen

Release 3.5.3 (veröffentlicht am 20. Mär 2021)

Hinzugefügte Funktionen

  • #8959: Verwendung des UNIX-Pfadtrennzeichens in der Bilddirektive verwirrt Sphinx unter Windows

Release 3.5.2 (veröffentlicht am 06. Mär 2021)

Behobene Fehler

  • #8943: i18n: Absturz durch fehlerhafte Übersetzungsnachrichten in ES, EL und HR

  • #8936: LaTeX: Ein benutzerdefinierter LaTeX-Builder schlägt mit einem Fehler bei unbekanntem Knoten fehl

  • #8952: Ausnahmen, die in einer Direktive ausgelöst werden, lassen parallele Builds hängen

Release 3.5.1 (veröffentlicht am 16. Feb 2021)

Behobene Fehler

  • #8883: autodoc: AttributeError wird beim Zuweisen von __annotations__ auf einer schreibgeschützten Klasse ausgelöst

  • #8884: html: Minifizierte JS-Stemmer sind nicht im verteilten Paket enthalten

  • #8885: html: AttributeError wird ausgelöst, wenn CSS/JS-Dateien über html_context installiert werden

  • #8880: viewcode: ExtensionError wird bei inkrementellen Builds nach dem Finden eines nicht parsebaren Python-Moduls ausgelöst

Release 3.5.0 (veröffentlicht am 14. Feb 2021)

Abhängigkeiten

  • LaTeX: multicol (ist ohnehin ein erforderlicher Teil der offiziellen latex2e-Basisverteilung)

Inkompatible Änderungen

Veraltet

  • pending_xref-Knoten für die viewcode-Erweiterung

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.good

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue

  • sphinx.builders.linkcheck.node_line_or_0()

  • sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()

  • sphinx.ext.autodoc.directive.DocumenterBridge.reporter

  • sphinx.ext.autodoc.importer.get_module_members()

  • sphinx.ext.autosummary.generate._simple_info()

  • sphinx.ext.autosummary.generate._simple_warn()

  • sphinx.writers.html.HTMLTranslator.permalink_text

  • sphinx.writers.html5.HTML5Translator.permalink_text

Hinzugefügte Funktionen

  • #8022: autodoc: autodata- und autoattribute-Direktiven zeigen nicht den rechtsseitigen Wert der Variablen an, wenn der Docstring :meta hide-value: in der Info-Feld-Liste enthält

  • #8514: autodoc: Standardwerte von überladenen Funktionen werden aus der tatsächlichen Implementierung übernommen, wenn sie Ellipsen sind

  • #8775: autodoc: Unterstützung des Typ-Union-Operators (PEP-604) in Python 3.10 oder höher

  • #8297: autodoc: Erlaubt die Erweiterung von autodoc_default_options über Direktivenoptionen

  • #759: autodoc: Neue Konfiguration autodoc_preserve_defaults als experimentelle Funktion. Sie bewahrt die Standardargumentwerte von Funktionen im Quellcode und hält sie zur besseren Lesbarkeit nicht ausgewertet.

  • #8619: html: kbd-Rolle erzeugt anpassbare HTML-Tags für zusammengesetzte Tasten

  • #8634: html: Erlaubt die Änderung der Reihenfolge von JS/CSS über den Parameter priority für Sphinx.add_js_file() und Sphinx.add_css_file()

  • #6241: html: Erlaubt das Hinzufügen von JS/CSS-Dateien zu einer bestimmten Seite, wenn eine Erweiterung app.add_js_file() oder app.add_css_file() beim html-page-context-Ereignis aufruft

  • #6550: html: Erlaubt die Verwendung von HTML-Permalink-Texten über html_permalinks_icon

  • #1638: html: Permalinksymbole zu Glossarbegriffen hinzugefügt

  • #8868: html-Suche: Leistungsproblem bei massiven Listen

  • #8867: html-Suche: JavaScript-Stemmer-Code auf die neueste Version von Snowball (v2.1.0) aktualisiert

  • #8852: i18n: Erlaubt die Übersetzung von Überschriftensyntaxen in MyST-Parser

  • #8592: imgconverter: Verfügbarkeitsprüfung überspringen, wenn der Builder den Bildtyp unterstützt

  • #8573: napoleon: Erlaubt die Änderung des Stils benutzerdefinierter Abschnitte mit napoleon_custom_sections

  • #8004: napoleon: Typdefinitionen in Google-Style-Docstrings werden als Referenzen gerendert, wenn napoleon_preprocess_types aktiviert ist

  • #6241: mathjax: mathjax.js nur auf Dokumenten mit Gleichungen einschließen

  • #8775: py-Domäne: Unterstützung des Typ-Union-Operators (PEP-604)

  • #8651: std-Domäne: Kreuzreferenz für eine Rubrik mit Inline-Element ist fehlerhaft

  • #7642: std-Domäne: Optimierung der fallunabhängigen Übereinstimmung von Begriffen

  • #8681: viewcode: Unterstützt inkrementellen Build

  • #8132: project_copyright als Alias für copyright hinzugefügt

  • #207: highlight_language unterstützt jetzt mehrere Sprachen

  • #2030: code-block und literalinclude unterstützen automatisches Dedenting über die optionale :dedent: Option

  • C++, auch Hyperlink-Operatorüberladungen in Ausdrücken und Aliasdeklarationen.

  • #8247: Produktionslisten erlauben die Referenzierung von Tokens aus anderen Produktionsgruppen

  • #8813: Zeigt an, welche Erweiterung (oder Modul) den Fehler bei der Ereignisbehandlung verursacht hat

  • #8213: C++: maxdepth-Option zu cpp:alias hinzugefügt, um verschachtelte Deklarationen einzufügen.

  • C, noroot-Option zu c:alias hinzugefügt, um nur verschachtelte Deklarationen zu rendern.

  • C++, noroot-Option zu cpp:alias hinzugefügt, um nur verschachtelte Deklarationen zu rendern.

Behobene Fehler

  • #8727: apidoc: Namespace-Moduldatei wird nicht generiert, wenn keine Untermodule vorhanden sind

  • #741: autodoc: geerbte Member funktionieren nicht für Instanzattribute der Superklasse

  • #8592: autodoc: :meta public: wirkt sich nicht auf Variablen aus

  • #8594: autodoc: leere __all__-Attribute werden ignoriert

  • #8315: autodoc: Fehler beim Auflösen des struct.Struct-Typ-Annotation

  • #8652: autodoc: Alle Variablenspeicher im Modul werden ignoriert, wenn das Modul ungültige Typspeicher enthält

  • #8693: autodoc: Standardwerte für überladene Funktionen werden als String gerendert

  • #8134: autodoc: Abstürze, wenn dekorierte Funktionen Argumente haben

  • #8800: autodoc: Nicht initialisierte Attribute in der Oberklasse werden als undokumentiert erkannt

  • #8655: autodoc: Fehler bei der Dokumentengenerierung, wenn das Zielmodul ein Objekt enthält, das bei hasattr() eine Ausnahme auslöst

  • #8306: autosummary: Mock-Module werden als leere Seite dokumentiert, wenn die Option :recursive: verwendet wird

  • #8232: graphviz: Bildknoten wird nicht gerendert, wenn sich die Grafikdatei in einem Unterverzeichnis befindet

  • #8618: html: kbd-Rolle erzeugt falsches HTML, wenn zusammengesetzte Tasten-Trennsymbole (-, + oder ^) als Tastenanschläge verwendet werden

  • #8629: html: Eine Typwarnung für html_use_opensearch wird zweimal angezeigt

  • #8714: html: kbd-Rolle mit „Caps Lock“ wird falsch gerendert

  • #8123: html-Suche: Korrektur der Suche nach Begriffen, die + enthalten (erfordert eine benutzerdefinierte Suchsprache, die nicht bei + trennt)

  • #8665: html-Theme: globaltoc_maxdepth konnte in theme.conf nicht überschrieben werden

  • #8446: html: aufeinanderfolgende Leerzeichen werden als einzelnes Leerzeichen angezeigt

  • #8745: i18n: Absturz mit KeyError, wenn eine Übersetzungsnachricht eine neue automatische Fußnotenreferenz hinzufügt

  • #4304: linkcheck: Behebung eines Race Conditions, die dazu führen konnte, dass die Verfügbarkeit derselben URL zweimal überprüft wurde

  • #8791: linkcheck: Der Docname für jeden Hyperlink wird nicht angezeigt

  • #7118: sphinx-quickstart: Fragebogen mit Mojibake, wenn libreadline nicht verfügbar ist

  • #8094: texinfo: Bilddateien in einem anderen Verzeichnis als das Dokument werden nicht kopiert

  • #8782: todo: Kreuzreferenzen in todolist sind fehlerhaft

  • #8720: viewcode: Modulseiten werden für EPUB bei inkrementellem Build generiert

  • #8704: viewcode: Anker werden bei inkrementellem Build nach singlehtml generiert

  • #8756: viewcode: Hervorgehobener Code wird generiert, auch wenn er nicht referenziert wird

  • #8671: highlight_options funktioniert nicht

  • #8341: C, Korrektur der intersphinx-Lookup-Typen für Namen in Deklarationen.

  • C, C++: im Allgemeinen Korrektur der intersphinx- und Rollen-Lookup-Typen.

  • #8683: html_last_updated_fmt unterstützt keine UTC-Offset (%z)

  • #8683: html_last_updated_fmt generiert falsche Zeitzone für %Z

  • #1112: download-Rolle erstellt doppelte Kopien, wenn ein relativer Pfad angegeben wird

  • #2616 (fünftes Element): LaTeX: Fußnoten aus Bildunterschriften sind nicht klickbar, und für manuell nummerierte Fußnoten ist nur die erste mit derselben Nummer ein Hyperlink

  • #7576: LaTeX mit französischem Babel und Memoir stürzt ab: „Illegal parameter number in definition of \FNH@prefntext“

  • #8055: LaTeX (Dokumente): Ein möglicher Anzeigefehler bei der LaTeX-Generierungsstufe in Sphinx (wie ein einspaltiges Verzeichnis generiert wird)

  • #8072: LaTeX: Direktive hlist nicht in LaTeX implementiert

  • #8214: LaTeX: Die index-Rolle und das Glossar erzeugen doppelte Einträge im LaTeX-Index (wenn beide für denselben Begriff verwendet werden)

  • #8735: LaTeX: falsche interne Links im PDF zu nummerierten Code-Blöcken, wenn numfig nicht True ist

  • #8442: LaTeX: einige indizierte Begriffe werden ignoriert, wenn die xelatex-Engine verwendet wird (oder pdflatex und latex_use_xindy auf True gesetzt ist) mit der memoir-Klasse

  • #8750: LaTeX: URLs als Fußnoten werden im PDF nicht angezeigt, wenn sie aus Funktions-Typsignaturen stammen

  • #8780: LaTeX: lange Wörter in schmalen Spalten werden möglicherweise nicht umgebrochen

  • #8788: LaTeX: \titleformat letztes Argument in sphinx.sty sollte in Klammern gesetzt sein, nicht in geschweiften Klammern (und wird ohnehin nicht benötigt)

  • #8849: LaTeX: code-block wird außerhalb des Rands gedruckt (siehe die optionale LaTeX-Syntax-Boolean verbatimforcewraps zur Verwendung über den ‘sphinxsetup’-Schlüssel von latex_elements)

  • #8183: LaTeX: Substitutionsreferenzknoten nur bei LaTeX-Builds aus dem Doctree entfernen

  • #8865: LaTeX: Indexknoten innerhalb von Titelknoten nur bei LaTeX-Builds umstrukturieren

  • #8796: LaTeX: potenziell kritischer Fehler in der unteren TeX-Kodierung ist bisher unbemerkt geblieben

  • C, c:alias überspringt Symbole ohne explizite Deklarationen, anstatt abzustürzen.

  • C, c:alias gibt eine Warnung aus, wenn das Wurzel-Symbol nicht deklariert ist.

  • C, expr-Rolle sollte die Symbolsuche im aktuellen Gültigkeitsbereich beginnen.