Sphinx 7.3

Release 7.3.7 (veröffentlicht 19. Apr. 2024)

Behobene Fehler

  • #12299: Verzögerung beim Laden von über Entry Points definierten Themes, bis sie explizit vom Benutzer oder einem Kind-Theme verwendet werden. Patch von Adam Turner.

  • #12305: Rückgabe des Standardwerts für theme.get_config() mit einem nicht unterstützten Theme-Konfigurationsabschnitt. Patch von Adam Turner.

Release 7.3.6 (veröffentlicht 17. Apr. 2024)

Behobene Fehler

  • #12295: Erneutes Exportieren aller AST-Typen in den C- und C++-Domains. Patch von Adam Turner.

  • #12295: Erneutes Exportieren verschiedener Objekte aus sphinx.domains.python._annotations in sphinx.domains.python. Patch von Jacob Chesslo und Adam Turner.

Release 7.3.5 (veröffentlicht 17. Apr. 2024)

Behobene Fehler

  • #12295: Erneutes Exportieren verschiedener Objekte aus sphinx.domains.python._object in sphinx.domains.python. Patch von Jacob Chesslo und Adam Turner.

Release 7.3.4 (veröffentlicht 17. Apr. 2024)

Behobene Fehler

  • Behandlung von Fällen, in denen Any keine Instanz von type ist. Patch von Adam Turner.

Release 7.3.3 (veröffentlicht 17. Apr. 2024)

Behobene Fehler

  • #12290: Behebung einer falsch-positiven Warnung beim Setzen eines Konfigurationswerts mit Any als gültigem Typ auf einen anderen Typ als den Standardwert des Werts. Patch von Adam Turner.

Release 7.3.2 (veröffentlicht 17. Apr. 2024)

Behobene Fehler

  • Vorabladen aller über Entry Points definierten Themes. Patch von Adam Turner.

  • Behebung einer fehlerhaften Interaktion zwischen dem Theme 'Furo' und der neuen Art von Konfigurationswerten. Patch von Adam Turner.

Release 7.3.1 (veröffentlicht 17. Apr. 2024)

Abhängigkeiten

  • Anforderung von tomli unter Python 3.10 und früher. Patch von Adam Turner.

Release 7.3.0 (veröffentlicht 16. Apr. 2024)

Abhängigkeiten

  • #11858: Erhöhung der minimal unterstützten Version von Alabaster auf 0.7.14. Patch von Adam Turner.

  • #12267: Unterstützung für Docutils 0.21. Patch von Adam Turner.

  • #12012: Verwendung von types-docutils anstelle von docutils-stubs.

Veraltet

  • #11693: Unterstützung für alte Makefile und make.bat Ausgaben in sphinx-quickstart und die zugehörigen Optionen -M, -m, --no-use-make-mode und --use-make-mode.

  • #11285: Direkter Zugriff auf sphinx.testing.util.SphinxTestApp._status oder sphinx.testing.util.SphinxTestApp._warning ist veraltet. Verwenden Sie stattdessen die öffentlichen Eigenschaften sphinx.testing.util.SphinxTestApp.status und sphinx.testing.util.SphinxTestApp.warning. Patch von Bénédikt Tran.

  • tests: sphinx.testing.util.strip_escseq() ist veraltet zugunsten von sphinx.util.console.strip_colors(). Patch von Bénédikt Tran.

Hinzugefügte Funktionen

  • #12265: Unterstützung der Theme-Konfiguration über theme.toml.

  • #11701: HTML-Suche: Übernahme des neuen <search>-Elements. Patch von Bénédikt Tran.

  • #11776: Hinzufügen langer Optionsnamen zu sphinx-build. Patch von Hugo van Kemenade, Adam Turner, Bénédikt Tran und Ezio Melotti.

  • Organisation der sphinx-build-Optionen in Gruppen. Patch von Adam Turner.

  • #11855: Verzögerung bei der Berechnung von Konfigurationswerten. Patch von Adam Turner.

  • Hinzufügen von :no-search: als Alias für das Metadatenfeld :nosearch:. Patch von Adam Turner.

  • #11803: autodoc: Verwendung einer überschriebenen __repr__()-Funktion in einem Enum, falls vorhanden. Patch von Shengyu Zhang.

  • #11825: Erlauben von benutzerdefinierten Zielen in der Manpage-Rolle. Patch von Nicolas Peugnet.

  • #11892: Verbesserte Leistung beim Auflösen von Querverweisen in der C++-Domain. Patch von Rouslan Korneychuk.

  • #11905: Hinzufügen der Direktive versionremoved. Patch von Hugo van Kemenade, Adam Turner und C.A.M. Gerlach.

  • #11981: Verbesserte Darstellung von Signaturen mit slice-Syntax, z.B. def foo(arg: np.float64[:,:]) -> None: ....

  • Der Manpage-Builder fügt jetzt OSC 8-Anker zu Hyperlinks hinzu, unter Verwendung des groff-Gerätesteuerbefehls.

  • #11015: Änderung des Textes der Direktive versionadded von New in [...] zu Added in [...]. Patch von Bénédikt Tran.

  • #12131: Hinzufügen der Konfigurationsoption show_warning_types. Patch von Chris Sewell.

  • #12193: Verbesserung von external-Warnungen für unbekannte Rollen. Insbesondere Vorschläge für verwandte Rollennamen, wenn ein Objekttyp fälschlicherweise verwendet wird. Patch von Chris Sewell.

  • Hinzufügen des öffentlichen Typ-Alias sphinx.util.typing.ExtensionMetadata. Dies kann von Extension-Entwicklern verwendet werden, um den Rückgabetyp ihrer setup-Funktion zu annotieren. Patch von Chris Sewell.

Behobene Fehler

  • #11668: Auslösen einer nützlichen Fehlermeldung, wenn theme.conf fehlt. Patch von Vinay Sajip.

  • #11622: Sicherstellen, dass die Reihenfolge der Schlüssel in searchindex.js deterministisch ist. Patch von Pietro Albini.

  • #11617: ANSI-Steuersequenzen werden aus der Ausgabe entfernt, wenn mit -w in eine Warnungsdatei geschrieben wird. Patch von Bénédikt Tran.

  • #11666: Überspringen aller versteckten Verzeichnisse in CatalogRepository.pofiles. Patch von Aryaz Eghbali.

  • #9686: html builder: Fehlerbehebung bei der verzögerten MathJax-Ladung, wenn Gleichungen in Titeln erscheinen. Patch von Bénédikt Tran.

  • #11483: singlehtml builder: Fehlerbehebung bei der verzögerten MathJax-Ladung, wenn der Index keine mathematischen Gleichungen enthält. Patch von Bénédikt Tran.

  • #11697: HTML-Suche: Hinzufügen des 'noindex' Meta-Robots-Tags. Patch von James Addison.

  • #11678: Behebung einer möglichen ZeroDivisionError in sphinx.ext.coverage. Patch von Stephen Finucane.

  • #11756: LaTeX: Build-Fehler mit neuerem TeXLive aufgrund fehlendem substitutefont-Paket (ausgelöst, wenn fontenc mit der Option T2A verwendet wird und die Dokumentensprache keine kyrillische ist). Patch von Jean-François B.

  • #11675: Fehlerbehebung bei der Darstellung von Fortschrittsbalken in Umgebungen, die keine ANSI-Steuersequenzen unterstützen. Patch von Bénédikt Tran.

  • #11861: Whitelisting weiterer Typen mit einem falschen __module__-Attribut. Patch von Adam Turner.

  • #11715: Anwenden von tls_verify und tls_cacerts Konfiguration auf ImageDownloader. Patch von Nick Touran.

  • Erlauben von Bindestrichen in Gruppennamen für Querverweise auf die Direktive productionlist. Patch von Adam Turner.

  • #11433: Hinzufügen der Konfigurationsoption linkcheck_allow_unauthorized. Setzen Sie diese Option auf False, um HTTP 401 (nicht autorisierte) Serverantworten als fehlerhaft zu melden. Patch von James Addison.

  • #11868: linkcheck: Hinzufügen eines eigenen Meldecodes für timeout. Dies kann durch Setzen von linkcheck_report_timeouts_as_broken auf False aktiviert werden. Patch von James Addison.

  • #11869: Aktualisierung der Dokumentation für die Einstellung linkcheck_timeout. Patch von James Addison.

  • #11874: Konfiguration eines Standardwerts von 30 Sekunden für linkcheck_timeout. Patch von James Addison.

  • #11886: Ausgabe der Jinja2-Template-Pfad-Kette in TemplateNotFound-Ausnahmen. Patch von Colin Marquardt.

  • #11598: Keine Verwendung von Query-Komponenten in URLs für Assets im EPUB-Rendering. Patch von David Runge.

  • #11904: Unterstützung für unäre Subtraktion beim Parsen von Annotationen. Patch von James Addison.

  • #11925: Blacklisting der Erweiterung sphinxprettysearchresults; die von ihr bereitgestellte Funktionalität wurde in Sphinx v2.0.0 zusammengeführt. Patch von James Addison.

  • #11917: Fehlerbehebung bei der Darstellung von annotierten geerbten Mitgliedern für Python 3.9. Patch von Janet Carson.

  • #11935: C Domain: Korrektur des Namespace-Pop-Kontexts. Patch von Frank Dana.

  • #11923: Vermeidung von Zombie-Prozessen bei fehlgeschlagenen parallelen Builds. Patch von Felix von Drigalski.

  • #11353: Unterstützung für Enumerationsklassen, die von Mixins oder Datentypen erben. Patch von Bénédikt Tran.

  • #11962: Fehlerbehebung bei der Zielauflösung bei Verwendung von :paramtype: Feldern. Patch von Bénédikt Tran.

  • #11944: Verwendung von Ankern in der Suchvorschau. Patch von Will Lachance.

  • #12008: Fehlerbehebung bei der Groß-/Kleinschreibung-unabhängigen Suche von std:label Namen im Intersphinx-Inventar. Patch von Michael Goerz.

  • #11958: HTML-Suche: Fehlerbehebung, dass teilweise übereinstimmende Treffer vollständige Treffer überschreiben. Patch von William Lachance.

  • #11959: Fehlerbehebung bei der mehrfachen Term-Übereinstimmung, wenn ein Wort sowohl im Titel als auch im Dokument vorkommt. Patch von Will Lachance.

  • #11474: Fehlerbehebung bei der Caching von Doctrees, das dazu führte, dass Dateien in einigen Fällen nicht neu erstellt wurden, z.B. wenn numfig True ist. Patch von Bénédikt Tran.

  • #11278: autodoc: Fehlerbehebung bei der Darstellung von functools.singledispatchmethod in Kombination mit @classmethod. Patch von Bénédikt Tran.

  • #11894: Hinzufügen von Checksummen zu CSS-Dateien beim Builden mit dem htmlhelp-Builder unterlassen. Patch von reduerK akiM.

  • #12052: Entfernen von <script>- und <style>-Tags aus dem Inhalt von Zusammenfassungs-Snippets von Suchergebnissen. Patch von James Addison.

  • #11578: HTML-Suche: Nicht-Haupt-Indexeinträge nach anderen Ergebnissen sortieren. Patch von Brad King.

  • #12147: autosummary: Behebung eines Fehlers, bei dem die falsche Dateierweiterung verwendet werden könnte, wenn mehrere Suffixe in source_suffix angegeben sind. Patch von Sutou Kouhei.

  • #10786: Verbesserung der Fehlermeldung, wenn eine zu kopierende Datei (z.B. ein Asset) während der Sphinx-Ausführung entfernt wird. Patch von Bénédikt Tran.

  • #12040: HTML-Suche: Sicherstellen, dass Dokumenttitel, die teilweise mit der Benutzersuchanfrage übereinstimmen, in den Suchergebnissen enthalten sind. Patch von James Addison.

  • #11970: singlehtml builder: Ziel-URIs als Same-Document-Referenzen im Sinne von RFC 3986, §4.4 machen, z.B. wird index.html#foo zu #foo. Patch von Eric Norige.

  • #12271: Teilweise Rückgängigmachung von Docutils’ r9562 zur Behebung von EPUB-Dateien. Patch von Adam Turner.

  • #12253: Maskieren reservierter Pfadzeichen im Cache für heruntergeladene Remote-Bilder. Patch von James Addison und Adam Turner.

Tests

  • Neuordnung der Tests in Verzeichnisse. Patch von Adam Turner.

  • Bereinigung des globalen Zustands in SphinxTestApp. Patch von Adam Turner.

  • #11285: pytest.mark.sphinx() und sphinx.testing.util.SphinxTestApp akzeptieren warningiserror, keep_going und verbosity als Schlüsselwortargumente. Patch von Bénédikt Tran.

  • #11285: Die Argumente status und warning von sphinx.testing.util.SphinxTestApp werden darauf überprüft, ob sie io.StringIO-Objekte sind (die öffentliche API ging fälschlicherweise davon aus, ohne dies zu überprüfen). Patch von Bénédikt Tran.

  • Meldung des Ergebnisses von test_run_epubcheck als skipped anstelle von success, wenn entweder Java oder epubcheck nicht verfügbar sind.

  • Verwendung der dynamischen Zuweisung ungenutzter Portnummern für die Test-HTTP(S)-Server. Als Nebeneffekt entfällt die Notwendigkeit von Testserver-Lockfiles, was bedeutet, dass alle verbleibenden tests/test-server.lock-Dateien sicher gelöscht werden können.