Sphinx 7.2

Release 7.2.6 (veröffentlicht 13. Sep. 2023)

Behobene Fehler

  • #11679: Fügt die Umgebungsvariable SPHINX_AUTODOC_RELOAD_MODULES hinzu, die, wenn sie gesetzt ist, Module neu lädt, wenn autodoc mit TYPE_CHECKING = True verwendet wird. Patch von Matt Wozniski und Adam Turner.

  • #11679: Verwendet importlib.reload(), um Module in autodoc neu zu laden. Patch von Matt Wozniski und Adam Turner.

Release 7.2.5 (veröffentlicht 30. Aug. 2023)

Behobene Fehler

  • #11645: Behebt eine Regression, die autodoc am Importieren von Modulen innerhalb von Paketen hinderte, die if typing.TYPE_CHECKING: verwenden, um zirkuläre Importe zu schützen, die von Type Checkern benötigt werden. Patch von Matt Wozniski.

  • #11634: Korrigierte Auflösung relativer Links für Vererbungdiagramme für Geschwisterdateien in einem Unterverzeichnis. Patch von Albert Shih.

  • #11659: Erlaubt ?config=... in mathjax_path.

  • #11654: autodoc: Schlägt mit einer aussagekräftigeren Fehlermeldung fehl, wenn ein Objekt behauptet, eine Instanz von type zu sein, aber keine Klasse ist. Patch von James Braza.

  • 11620: Stoppt das Senden von source-read-Ereignissen für Dateien, die über die include-Direktive gelesen wurden.

  • 11620: Fügt ein neues include-read zum Beobachten und Transformieren des Inhalts von inkludierten Dateien über die include-Direktive hinzu.

  • #11627: Stellt die Unterstützung für Copyright-Zeilen der Form YYYY wieder her, wenn SOURCE_DATE_EPOCH gesetzt ist.

Release 7.2.4 (veröffentlicht 28. Aug. 2023)

Behobene Fehler

  • #11618: Behebt eine Regression im MoveModuleTargets-Transform, eingeführt in #10478 (#9662).

  • #11649: linkcheck: Löst hängende Tests für Zeitzonen westlich von London und falsche Umwandlung von UTC in Offsets vom UNIX-Epoch. Patch von Dmitry Shachnev und Adam Turner.

Release 7.2.3 (veröffentlicht 23. Aug. 2023)

Abhängigkeiten

  • #11576: Erfordert sphinxcontrib-serializinghtml 1.1.9.

Behobene Fehler

  • Behebt Regression in autodoc.Documenter.parse_name().

  • Behebt Regression in JSON-Serialisierung.

  • #11543: autodoc: Unterstützt positionelle Parameter in classmethod-Methoden, wenn autodoc_preserve_defaults True ist.

  • Stellt die Unterstützung für String-Methoden auf Pfadobjekten wieder her. Dies ist veraltet und wird in Sphinx 8 entfernt. Verwenden Sie os.fspath(), um Path-Objekte in Strings zu konvertieren, oder die Methoden von Path, um mit Pfadobjekten zu arbeiten.

Release 7.2.2 (veröffentlicht 17. Aug. 2023)

Behobene Fehler

  • Korrigiert die Signatur des StateMachine.insert_input()-Patches, wenn mit Schlüsselwortargumenten aufgerufen wird.

  • Korrigiert die Mitgliedschaftsprüfung (in) für die str-Schnittstelle der Asset-Klassen (_CascadingStyleSheet und _JavaScript), auf die mehrere Erweiterungen angewiesen waren.

  • Korrigiert einen Typfehler in SingleFileHTMLBuilder._get_local_toctree, includehidden kann als String oder Boolean übergeben werden.

  • Korrigiert :noindex: für PyModule und JSModule.

Release 7.2.1 (veröffentlicht 17. Aug. 2023)

Behobene Fehler

  • Stellt die str-Schnittstelle der Asset-Klassen (_CascadingStyleSheet und _JavaScript) wieder her, auf die mehrere Erweiterungen angewiesen waren. Dies wird in Sphinx 9 entfernt.

  • Stellt Aufrufe von Builder.add_{css,js}_file() wieder her, auf die mehrere Erweiterungen angewiesen waren.

  • Stellt die private API TocTree.get_toctree_ancestors() wieder her, auf die mehrere Erweiterungen angewiesen waren.

Release 7.2.0 (veröffentlicht 17. Aug. 2023)

Abhängigkeiten

  • #11511: Beendet die Unterstützung für Python 3.8.

  • #11576: Erfordert Pygments 2.14 oder höher.

Veraltet

  • #11512: Veraltet sphinx.util.md5 und sphinx.util.sha1. Verwenden Sie stattdessen hashlib.

  • #11526: Veraltet sphinx.testing.path. Verwenden Sie stattdessen os.path oder pathlib.

  • #11528: Veraltet sphinx.util.split_index_msg und sphinx.util.split_into. Verwenden Sie stattdessen sphinx.util.index_entries.split_index_msg.

  • Veraltet sphinx.builders.html.Stylesheet und sphinx.builders.html.Javascript. Verwenden Sie stattdessen sphinx.application.Sphinx.add_css_file() und sphinx.application.Sphinx.add_js_file().

  • #11582: Veraltet sphinx.builders.html.StandaloneHTMLBuilder.css_files und sphinx.builders.html.StandaloneHTMLBuilder.script_files. Verwenden Sie stattdessen sphinx.application.Sphinx.add_css_file() und sphinx.application.Sphinx.add_js_file().

  • #11459: Veraltet sphinx.ext.autodoc.preserve_defaults.get_function_def(). Patch von Bénédikt Tran.

Hinzugefügte Funktionen

  • #11526: Unterstützt os.PathLike-Typen und pathlib.Path-Objekte an vielen weiteren Stellen.

  • #5474: coverage: Druckt zusammenfassende Statistiken. Patch von Jorge Leitao.

  • #6319: viewcode: Fügt viewcode_line_numbers hinzu, um zu steuern, ob Zeilennummern zum gerenderten Quellcode hinzugefügt werden. Patch von Ben Krikler.

  • #9662: Fügt die Option :no-typesetting: hinzu, um die Textausgabe zu unterdrücken und nur einen verlinkbaren Anker zu erstellen. Patch von Latosha Maltba.

  • #11221: C++: Unterstützt Domain-Objekte im Inhaltsverzeichnis. Patch von Rouslan Korneychuk.

  • #10938: doctest: Fügt die Option doctest_show_successes hinzu. Patch von Trey Hunner.

  • #11533: Fügt :no-index:, :no-index-entry: und :no-contents-entry: hinzu.

  • #11572: Verbessert die debug-Protokollierung von Gründen, warum Dateien als veraltet erkannt werden. Patch von Eric Larson.

  • #10678: Sendet source-read-Ereignisse für Dateien, die über die include-Direktive gelesen wurden. Patch von Halldor Fannar.

  • #11570: Verwendet kurze Namen bei Verwendung von PEP 585-eingebauten Generics. Patch von Riccardo Mori.

  • #11300: Verbessert die Fallback-Logik von SigElementFallbackTransform und die Signatur-Textelemente-Knoten. Weitere Details finden Sie in der Dokumentation. Patch von Bénédikt Tran.

  • Erlaubt das Ausführen von Sphinx mit python -m sphinx build ....

Behobene Fehler

  • #11077: graphviz: Korrigiert relative Links von innerhalb des Graphen. Patch von Ralf Grubenmann.

  • #11529: Line Block im LaTeX-Builder gibt ein überflüssiges leeres Token aus. Patch von Adrian Vollmer.

  • #11196: autosummary: Extraktion der Zusammenfassungszeile schlug mit „z. B.“ fehl.

  • #10614: Korrigiert eine Reihe von Fehlern in Vererbungdiagrammen, die zu fehlenden oder kaputten Links führten. Patch von Albert Shih.

  • #9428: Schließt Substitutionsdefinitionen beim Ausführen des gettext-Builders aus. Patch von Alvin Wong.

  • #10795: Löst einen aussagekräftigen Fehler aus, wenn graphviz_dot falsy ist.

  • #11546: Übersetzte Knoten, die mit ihrem Originaltext identisch sind, werden nun mit dem Attribut translated=True markiert.

  • #10049: html: Ändert „Permalink“ zu „Link“ für den Titeltext in Linkankern.

  • #4225: Lockerere Pygments-Analyse bei Lexing-Fehlern.

  • #11246: Erlaubt Inline-Links in der ersten Zeile eines Docstrings und Einzeilen-Typkommentaren #: :meta ...: bei Verwendung von sphinx.ext.napoleon. Patch von Bénédikt Tran.

  • #10930: Hebt alle Suchbegriffe auf der Suchergebnisseite hervor. Patch von Dmitry Shachnev.

  • #11473: Typannotationen, die Literal-Aufzählungswerte enthalten, werden nun korrekt gerendert. Patch von Bénédikt Tran.

  • #11591: Korrigiert die Unterstützung für C-Coverage in der sphinx.ext.coverage-Erweiterung. Patch von Stephen Finucane.

  • #11594: HTML-Theme: Verbesserungen beim horizontalen Scrollen auf kleineren Geräten im agogo-Theme. Patch von Lukas Engelter.

  • #11459: Korrigiert die Unterstützung für asynchrone und Lambda-Funktionen in sphinx.ext.autodoc.preserve_defaults. Patch von Bénédikt Tran.

Tests

  • #11577: pytest: Teste schlägt bei „XPASS“ fehl.

  • #11577: pytest: Verwendet den Importmodus „importlib“.

  • #11577: pytest: Setzt PYTHONWARNINGS=error.

  • #11577: pytest: Setzt strenge Konfiguration und strenge Marker.