Sphinx 8.2

Release 8.2.3 (veröffentlicht am 02. März 2025)

Behobene Fehler

  • #13403: Definieren von _StrPath.__radd__(). Patch von Adam Turner.

  • #13399: Korrigieren des `_CurrentDocument`-Membership-Tests mit '{c,cpp}:parent_symbol'. Patch von Adam Turner.

Release 8.2.2 (veröffentlicht am 02. März 2025)

Behobene Fehler

  • #13392: Korrigieren des Argumenttyps für jieba.load_userdict().

  • Workaround für implizite nbsphinx-Imports hinzugefügt. Patch von Adam Turner.

  • #13402: Sicherstellen, dass Inline-`<script/>`-Tags genau einmal geschrieben werden. Patch von Dmitry Shachnev und Adam Turner.

  • #13391: apidoc: Korrigieren der TOC-Datei, die keinen Titel hat. Patch von Dave Hoese und Adam Turner.

Release 8.2.1 (veröffentlicht am 21. Februar 2025)

Behobene Fehler

  • #13367: Korrigieren der Rechtschreibung von highlighting_failure im Warnungssubtyp. Patch von Bart Kamphorst.

  • #13377: Wiederherstellen der Unterstützung für die Verwendung von sphinx.testing.path-Pfaden mit sphinx.testing.fixtures. Patch von Kazuya Takei.

  • #13380: viewcode: Korrigieren des mehrfachen Imports von Modulen. Patch von Dave Hoese.

  • #13382: Napoleon: Verwenden der richtigen gültigen Typen für Konfigurationswerte. Patch von Adam Turner.

  • #13376: Korrigieren des Kopierens von Assets aus relativen html_static_path und html_extra_path-Einträgen. Patch von Adam Turner.

Release 8.2.0 (veröffentlicht am 18. Februar 2025)

Abhängigkeiten

  • #13000: Unterstützung für Python 3.10 einstellen.

Inkompatible Änderungen

  • #13044: Entfernen der internen und undokumentierten has_equations-Daten aus der MathDomain-Domäne. Die undokumentierte Methode MathDomain.has_equations() gibt jetzt bedingungslos True zurück. Diese werden durch den Schlüssel has_maths_elements des Seitenkontext-Wörterbuchs ersetzt. Patch von Adam Turner.

  • #13227: Die HTML-Ausgabe für Sequenzen von Schlüsseln in der kbd-Rolle verwendet kein <kbd class="kbd compound">-Element mehr, um die Schlüssel und Trennzeichen zu umschließen, sondern platziert sie direkt im entsprechenden übergeordneten Knoten. Das bedeutet, dass CSS-Regeln, die auf kbd.compound oder .kbd.compound abzielen, keine Auswirkung mehr haben werden. Patch von Adam Turner.

Veraltet

  • #13037: Deprecieren der Methode SingleHTMLBuilder.fix_refuris. Patch von James Addison.

  • #13083, #13330: sphinx.util.import_object wiederentkräften. Patch von Matthias Geier.

Hinzugefügte Funktionen

  • #13173: Einen neuen Warnungstyp duplicate_declaration mit den Subtypen duplicate_declaration.c und duplicate_declaration.cpp hinzufügen. Patch von Julien Lecomte und Adam Turner.

  • #11824: linkcode: Erweiterungen erlauben, Unterstützung für eine Domäne hinzuzufügen, indem die erforderlichen Schlüssel definiert werden. Patch von Nicolas Peugnet.

  • #13144: Eine Option class zur Direktive autosummary hinzufügen. Patch von Tim Hoffmann.

  • #13146: Napoleon: Vereinheitlichen der Typ-Vorverarbeitungslogik, um Google-Style-Docstrings die Schlüsselwörter optional und default zu erlauben. Patch von Chris Barrick.

  • #13227: Implementieren der kbd-Rolle als SphinxRole. Patch von Adam Turner.

  • #13065: Farben standardmäßig aktivieren, wenn auf CI ausgeführt. Patch von Adam Turner.

  • #13230: Zulassen, Warnungen von der toctree-Direktive zu unterdrücken, wenn ein Glob-Muster keine Dokumente findet, über den neuen Warnungssubtyp toc.empty_glob. Patch von Slawek Figiel.

  • #9732: Den neuen Warnungssubtyp autodoc.mocked_object hinzufügen. Patch von Cyril Roelandt.

  • #7630, #4824: autodoc: Verwenden von .pyi-Typ-Stubdateien, um native Module automatisch zu dokumentieren. Patch von Adam Turner, teilweise basierend auf der Arbeit von Allie Fitter.

  • #12975: Konfiguration von nachgestellten Kommas in mehrzeiligen Signaturen in den Python- und Javascript-Domänen über die neuen Konfigurationsoptionen python_trailing_comma_in_multi_line_signatures und javascript_trailing_comma_in_multi_line_signatures ermöglichen.

  • #13264: Umbenennen der Option nowrap der math-Direktive in math:no-wrap. Patch von Adam Turner.

  • #13269: Hinzufügen der Option, die Verwendung von Typ-Kommentaren über die neue Option autodoc_use_type_comments zu deaktivieren, die standardmäßig auf True gesetzt ist, um die Abwärtskompatibilität zu gewährleisten. Der Standardwert wird in Sphinx 10 auf False geändert. Patch von Adam Turner.

  • #9732: Hinzufügen des neuen Warnungssubtyps ref.any, um die mehrdeutige Warnung bezüglich Kreuzreferenzen zu 'any' zu unterdrücken. Patch von Simão Afonso und Adam Turner.

  • #13272: Die Python- und JavaScript-Modul-Direktiven unterstützen nun die Option :no-index-entry:. Patch von Adam Turner.

  • #12233: autodoc: Zulassen, dass Direktiven :no-index-entry: verwenden und die Optionen :no-index: und :no-index-entry: innerhalb von autodoc_default_options einschließen. Patch von Jonny Saunders und Adam Turner.

  • #13172: Unterstützung für kurze Signaturen in autosummary hinzufügen. Patch von Tim Hoffmann.

  • #13271: Ändern des Signaturpräfixes für abstrakte Methoden in der Python-Domäne von abstract auf abstractmethod. Patch von Adam Turner.

  • #13271: Unterstützen der Option :abstract: für Klassen, Methoden und Eigenschaften in der Python-Domäne. Patch von Adam Turner.

  • #12507: Hinzufügen der kollabierbaren Option zu Admonition-Direktiven. Patch von Chris Sewell.

  • #8191, #8159: Hinzufügen der Option inheritance-diagram:include-subclasses zur inheritance-diagram-Direktive. Patch von Walter Dörwald.

  • #11995: autodoc: Unterstützung für python_display_short_literal_types hinzufügen. Patch von Bénédikt Tran und Adam Turner.

  • #13163: Immer den vollständigen Kontext ausgeben, wenn Sphinx auf einen internen Fehler stößt. Patch von Kevin Deldycke und Adam Turner.

  • #13105: Einführung der py:deco-Rolle zur Kreuzreferenzierung von Decorator-Funktionen und -Methoden in der Python-Domäne. Patch von Adam Turner.

  • #9169: Hinzufügen der Option intersphinx_resolve_self, um eine Intersphinx-Referenz auf das aktuelle Projekt aufzulösen. Patch von Jakob Lykke Andersen und Adam Turner.

  • #11280: Hinzufügen der Möglichkeit, einen bestimmten Abschnitt mit der Klasse no-search zu überspringen. Patch von Will Lachance.

  • #13326: Entfernen von Hardcoding bei der Behandlung von productionlist-Knoten in allen Writern, um die Flexibilität zu verbessern. Patch von Adam Turner.

  • #13335: Verwenden des Subtyps misc.highlighting_failure für unbekannte Pygments-Lexer. Patch von Bart Kamphorst.

  • #13354: Einfügen von Abbildungsknoten (Hover-Text) für positionsbezogene und schlüsselwortbezogene Trennzeichen in Python-Signaturen. Patch von Adam Turner.

  • #13333: Hinzufügen der Erweiterung sphinx.ext.apidoc zur Automatisierung der Generierung von API-Dokumentation aus Python-Modulen. Patch von Chris Sewell und Adam Turner.

Behobene Fehler

  • #12463: autosummary: Berücksichtigen eines leeren Modul-`__all__`. Patch von Valentin Pratz

  • #13060: HTML-Suche: Verwenden von Map zum Speichern von Term-Scores pro Datei. Patch von James Addison

  • #13130: LaTeX-Docs: Die Erstellung des Index mit pdflatex kann für Indexeinträge in französischer Sprache fehlschlagen. Siehe latex_use_xindy. Patch von Jean-François B.

  • #13152: LaTeX: Korrigieren eines Tippfehlers aus v7.4.0 in einem Standardwert für \sphinxboxsetup. Patch von Jean-François B.

  • #13096: HTML-Suche: Prüfen, ob Abfrageterme als Eigenschaften in Termindizes vorhanden sind, bevor darauf zugegriffen wird.

  • #11233: linkcheck: Umleitungs-URIs mit linkcheck_ignore abgleichen, indem requests.get_redirect_target auf Sitzungsebene überschrieben wird.

  • #13195: viewcode: Problem beheben, bei dem Importpfade vom Verzeichnisbaum abweichen. Patch von Ben Egan und Adam Turner.

  • #13188: autodoc: Korrigieren der Erkennung von Klassenmethoden, die in C implementiert sind. Patch von Bénédikt Tran.

  • #1810: Statische Dateien immer beim Erstellen kopieren, unabhängig davon, ob seit dem vorherigen Erstellungslauf Dokumente geändert wurden. Patch von Adam Turner.

  • #13201: autodoc: Korrigieren der Reihenfolge von Mitgliedern bei Verwendung von groupwise für autodoc_member_order. Klassenmethoden werden nun vor statischen Methoden gerendert, die selbst vor regulären Methoden und Attributen gerendert werden. Patch von Bénédikt Tran.

  • #12975: Vermeiden des Renderns eines nachgestellten Kommas in mehrzeiligen C- und C++-Signaturen.

  • #13178: autodoc: Korrigieren der Auflösung für pathlib-Typen. Patch von Adam Turner.

  • #13136: autodoc: Korrektes Behandeln von Mehrfachvererbung. Patch von Pavel Holica

  • #13273, #13318: Überschreibungen von Befehlszeilenargumenten für Boolesche Typen korrekt konvertieren. Patch von Adam Turner.

  • #13302, #13319: Korrekte Einrückung für Fortsetzungszeilen in productionlist-Direktiven verwenden. Patch von Adam Turner.

  • #13328: Korrigieren des Parsens von PEP 695-Funktionen mit Rückgabeannotationen. Patch von Bénédikt Tran. Erste Arbeit von Arash Badie-Modiri.

Tests

  • #13224: Korrekturfix für test_html_multi_line_copyright. Patch von Colin Watson, angewendet von James Addison.