Sphinx 7.4¶

Release 7.4.7 (veröffentlicht am 20. Juli 2024)¶

Behobene Fehler¶

#12096: Warnen, wenn Dateien im Build-Verzeichnis überschrieben werden. Patch von Adam Turner und Bénédikt Tran.
#12620: Sicherstellen, dass alte Objektbeschreibungsoptionen berücksichtigt werden. Patch von Adam Turner.
#12601, #12625: Unterstützung für aufrufbare Objekte in Annotated-Typmetadaten in der Python-Domäne. Patch von Adam Turner.
#12601, #12622: Beheben von Annotated-Warnungen mit sphinx.ext.autodoc, insbesondere bei Verwendung von dataclasses als Typmetadaten. Patch von Adam Turner.
#12589, #12626: autosummary: Behebung von Warnungen mit autolink. Patch von Adam Turner.

Release 7.4.6 (veröffentlicht am 18. Juli 2024)¶

Behobene Fehler¶

#12589, #9743, #12609: autosummary: Paketpräfix nicht hinzufügen, wenn Autosummary-Direktiven für Module innerhalb eines Pakets generiert werden. Patch von Adam Turner.
#12613: Reduzierung der Protokollschwere für Ambiguitätserkennung beim Laden von Inventaren. Patch von James Addison.

Release 7.4.5 (veröffentlicht am 16. Juli 2024)¶

Behobene Fehler¶

#12593, #12600: Rückgängigmachen der Erzwingung des Typs von ausgewählten html_sidebars-Werten zu einer Liste. Protokollieren einer Fehlermeldung, wenn Zeichenkettenwerte erkannt werden. Patch von Adam Turner.
#12594: LaTeX: Seit 7.4.0 brechen seealso und andere „light“-Admonitions PDF-Builds, wenn sie eine figure-Direktive enthalten; und auch, wenn sie sich in einer Tabellenzelle befinden (gerendert von tabulary). Patch von Jean-François B.

Release 7.4.4 (veröffentlicht am 15. Juli 2024)¶

Behobene Fehler¶

#12585, #12586: Keine Warnung ausgeben, wenn ein Intersphinx-Inventar Elemente enthält, die fallunabhängig mehrdeutig sind. Patch von James Addison.

Release 7.4.3 (veröffentlicht am 15. Juli 2024)¶

Behobene Fehler¶

#12582: Wiederherstellung der Unterstützung für Listen-Stil-Werte für source_suffix mit Erweiterungen, die Parser registrieren. Patch von Adam Turner.

Release 7.4.2 (veröffentlicht am 15. Juli 2024)¶

Behobene Fehler¶

#12580, #12583: Behebung von Fehlern mit der C-Domäne bei inkrementellen Builds mit Sphinx 7.3.7 und früher. Patch von Adam Turner.

Release 7.4.1 (veröffentlicht am 15. Juli 2024)¶

Behobene Fehler¶

Ungültiges HTML, wenn ein Rubrik-Knoten mit ungültigem heading-level verwendet wird, wird behoben. Patch von Adam Turner.
#12579, #12581: Wiederherstellung der Unterstützung für typing.ParamSpec in autodoc. Patch von Adam Turner.

Release 7.4.0 (veröffentlicht am 15. Juli 2024)¶

Abhängigkeiten¶

#12555: Unterstützung für Docutils 0.18.1 und Docutils 0.19 eingestellt. Patch von Adam Turner.
LaTeX: Das Paket xcolor ist nun erforderlich (ist aber zum Beispiel Teil von Ubuntu texlive-latex-recommended, das immer erforderlich war).
LaTeX: Das LaTeX-Paket fontawesome5 wird für die Standardauswahl an Symbolen benötigt, die nun in Admonition-Titeln in der PDF-Ausgabe verwendet werden; falls nicht verfügbar, wird die PDF-Erstellung solche Symbole stillschweigend weglassen. Informationen finden Sie in der Dokumentation zum Schlüssel iconpackage von ‚sphinxsetup‘.

Veraltet¶

LaTeX: Die Umgebung sphinxlightbox wird nicht mehr verwendet, alle Arten von Admonitions verwenden (standardmäßig) nur sphinxheavybox.

Hinzugefügte Funktionen¶

#11165: Unterstützung für die offiziell empfohlene Dateiendung .jinja für Vorlagendateien. Patch von James Addison und Adam Turner
#12325: Union[Literal[T], Literal[U], ...] wird zu Literal[T, U, ...] abgeflacht, wenn Annotationen in Zeichenketten umgewandelt werden. Patch von Adam Turner.
#12319: sphinx.ext.extlinks: Hinzufügen der CSS-Klasse extlink-{name} zu Links. Patch von Hugo van Kemenade.
#12387: Verbesserung der CLI-Fortschrittsmeldung beim Kopieren von Assets. Patch von INADA Nakoi und Bénédikt Tran.
#12361: Hinzufügen von BuildEnvironment.parser. Patch von Chris Sewell.
#12358: Hinzufügen von Sphinx.fresh_env_used. Patch von Chris Sewell.
#12329: Hinzufügen der Erkennung von mehrdeutigen std:label und std:term Referenzen beim Laden und Auflösen von Intersphinx-Zielen. Patch von James Addison.
#12422: Vermeiden von Duplikaten von „Navigation“ im Aria-Label der integrierten Themes. Patch von Thomas Weißschuh
#12421: Einbeziehen des Projektnamens in logo_alt der integrierten Themes. Patch von Thomas Weißschuh
#12448: Hinzufügen der Option sphinx-apidoc --remove-old. Patch von Chris Sewell.
#12456: Hinzufügen der Option sphinx-autogen --remove-old. Patch von Chris Sewell.
#12479: Hinzufügen des Warnung-Subtyps toc.no_title. Patch von Ondřej Navrátil.
#12492: Hinzufügen von Hilfsmethoden zum Parsen von reStructuredText-Inhalten in Knoten aus einer Direktive.
- parse_content_to_nodes() parst den Inhalt der Direktive und gibt eine Liste von Docutils-Knoten zurück.
- parse_text_to_nodes() parst den bereitgestellten Text und gibt eine Liste von Docutils-Knoten zurück.
- parse_inline() parst den bereitgestellten Text in Inline-Elemente und Textknoten.
Patch von Adam Turner.
#12258: Unterstützung für typing_extensions.Unpack. Patch von Bénédikt Tran und Adam Turner.
#12524: Hinzufügen einer class-Option zur toctree-Direktive. Patch von Tim Hoffmann.
#12536: Hinzufügen der confval-Direktive. Patch von Adam Turner.
#12537: c_id_attributes, c_paren_attributes, cpp_id_attributes und cpp_paren_attributes können nun ein Tupel von Zeichenketten sein. c_extra_keywords, gettext_additional_targets, html_domain_indices, latex_domain_indices und texinfo_domain_indices können nun eine Menge von Zeichenketten sein. Patch von Adam Turner.
#12523: Konfigurationsoption math_numsep hinzugefügt, um den Trenner für die Mathematiknummerierung zu definieren. Patch von Thomas Fanning
#11592: coverage_modules zum Coverage-Builder hinzugefügt, um explizit anzugeben, welche Module dokumentiert werden sollen. Patch von Stephen Finucane.
#7896, #11989: py:type-Direktive zur Dokumentation von Typalias und eine py:type-Rolle zum Verknüpfen mit ihnen hinzugefügt. Patch von Ashley Whetter.
#12549: Optionales description-Argument zu Sphinx.add_config_value() hinzugefügt. Patch von Chris Sewell.
#6792: Modulimportzyklen in sphinx.ext.autosummary verboten. Patch von Trevor Bekolay.
#12508: LaTeX: Überarbeitetes Styling aller Admonitions, mit Hinzufügen einer Titelleiste mit Symbol. Patch von Jean-François B.
#11773: Annotated-Annotationen mit ihren Metadaten in der Python-Domäne anzeigen. Patch von Adam Turner und David Stansby.
#12506: Option heading-level zur rubric-Direktive hinzugefügt. Patch von Chris Sewell.
#12567: Hinzufügen des Ereignisses write-started. Patch von Chris Sewell.

Behobene Fehler¶

#12314: collections.abc.Callable in Annotationen richtig formatieren. Patch von Adam Turner.
#12162: Behebung einer Performance-Regression in der C-Domäne, die seit Version 3.0.0 bestand. Patch von Donald Hunter.
#12320: Behebung der Entfernung von Ankern aus Suchzusammenfassungen (Regression in 7.3.0). Patch von Will Lachance.
#12251: Behebung von merge_domaindata() in sphinx.ext.duration. Patch von Matthias Geier.
#12224: WebP-Dateien richtig erkennen. Patch von Benjamin Cabé.
#12380: LaTeX: Vermeiden von Fußnotenmarkern Page N, wenn N bereits die aktuelle Seitenzahl ist. Patch von Jean-François B.
#12410: LaTeX: für Französisch und 'lualatex' als latex_engine babel wie bei 'xelatex' verwenden (und nicht polyglossia). Patch von Jean-François B.
#8807, #12520: LaTeX: todolist soll korrekte Hyperlinks in PDF erzeugen. Patch von Jean-François B.
#12416: Sicherstellen, dass Konfigurationsaliase immer synchronisiert werden, wenn der eine oder andere Wert geändert wird. Patch von Bénédikt Tran.
#12220: Behebung des Ladens benutzerdefinierter Vorlagenübersetzungen für die Locale en. Patch von Nicolas Peugnet.
#12459: Gültige Typargumente zur Konfigurationseinstellung linkcheck_rate_limit_timeout hinzugefügt. Patch von James Addison.
#12331: Behebung einer Regression bei der Extraktion von Data-URI-Bildern aus v7.3.0, die Builder ohne native Unterstützung für Data-URIs in ihrem Ausgabeformat betraf. Patch von James Addison.
#12494: Behebung der ungültigen genindex.html-Datei, die mit übersetzten Dokumenten erstellt wurde (Regression in 7.1.0). Patch von Nicolas Peugnet.
#11961: Ankerreferenzen aus Dokumenttitelei-Einträgen im Suchindex weglassen, um Duplikate von Suchergebnissen zu vermeiden. Patch von James Addison.
#12425: Docutils' SVG-Verarbeitung im HTML-Builder verwenden und die benutzerdefinierte Logik von Sphinx entfernen. Patch von Tunç Başar Köse.
#12391: Anpassung der Gewichtung von Treffern während der HTML-Suche, sodass Dokumenthaupttitel tendenziell höher eingestuft werden als Unterabschnittstitel. Zusätzlich werden Treffer im Namen von Programmierobjekten gegenüber Titeln/Untertitel-Treffern aufgewertet. Patch von James Addison und Will Lachance.
#9634: Keine Fallback-Sprache hinzufügen, indem der Ländercode entfernt wird. Patch von Alvin Wong.
#12352: Domänenobjekte in derselben Reihenfolge wie im Dokument definiert zur Inhaltsübersicht hinzufügen. Zuvor verwendete jede Domäne sprachspezifische Verschachtelungsregeln, die die Kontrolle von den Dokumentenerstellern nahmen. Patch von Jakob Lykke Andersen und Adam Turner.
#11041: linkcheck: URLs ignorieren, die mit Nicht-Unicode-Inhalt antworten. Patch von James Addison.
#12543: Behebung der PEP 695-Formatierung für LaTeX-Ausgabe. Patch von Bénédikt Tran.

Tests¶

karma: HTML-Suchtests refaktorieren, um Fixtures zu verwenden, die von Sphinx generiert wurden. Patch von James Addison.