Sphinx 8.1

Release 8.1.3 (veröffentlicht am 13. Okt. 2024)

Behobene Fehler

  • #13013: Unterstützung für cut_lines() ohne Objekttyp wiederhergestellt. Patch von Adam Turner.

Release 8.1.2 (veröffentlicht am 12. Okt. 2024)

Behobene Fehler

  • #13012: sphinx.errors.ExtensionError für Abwärtskompatibilität in sphinx.util verfügbar gemacht. Dies wird in Sphinx 9 entfernt, da die Ausnahme in sphinx.util nie beabsichtigt war. ExtensionError ist seit Sphinx 0.9 Teil von sphinx.errors. Patch von Adam Turner.

Release 8.1.1 (veröffentlicht am 11. Okt. 2024)

Behobene Fehler

  • #13006: Die bevorzugte URL https://www.cve.org/ für die :cve:-Rolle verwendet. Patch von Hugo van Kemenade.

  • #13007: LaTeX: Verbesserte Ausfallsicherheit, wenn die erforderlichen Pakete fontawesome oder fontawesome5 nicht installiert sind. Patch von Jean-François B.

Release 8.1.0 (veröffentlicht am 10. Okt. 2024)

Abhängigkeiten

  • #12756: Untergrenzen zu den sphinxcontrib-*-Abhängigkeiten hinzugefügt. Patch von Adam Turner.

  • #12833: Aktualisierung des LaTeX-Pakets parskip von 2001 auf 2018. Patch von Jean-François B.

Inkompatible Änderungen

  • #12763: Unbenutzte interne Klasse sphinx.util.Tee entfernt. Patch von Adam Turner.

  • #12822: LaTeX: Für Unicode-Engines wird der Standardwert 'fvset' auf '\\fvset{fontsize=auto}' von '\\fvset{fontsize=\\small}' geändert. Codeblöcke sind unverändert, da FreeMono jetzt mit Scale=0.9 geladen wird. Eine Anpassung bestehender Projekte ist nur dann erforderlich, wenn sie ein benutzerdefiniertes 'fontpkg'-Konfiguration verwendet und 'fvset' nicht gesetzt hat. Patch von Jean-François B.

  • #12875: Deaktivierung von Smartquotes für Sprachen: zh_CN und zh_TW standardmäßig. Patch von A. Rafey Khan.

Veraltet

  • #12762: sphinx.util.import_object deprecatiert. stattdessen importlib.import_module() verwenden. Patch von Adam Turner.

  • #12766: sphinx.util.FilenameUniqDict und sphinx.util.DownloadFiles deprecatiert. Patch von Adam Turner.

Hinzugefügte Funktionen

  • #11328: Erwähnung der Auswertung von vorlagenbasiertem Inhalt bei der Erstellung statischer Ausgabedateien. Patch von James Addison.

  • #12704: LaTeX: contents, topic und sidebar-Direktiven separat für PDF-Ausgabe anpassbar gemacht. Patch von Jean-François B. und Bénédikt Tran.

  • #12474: Unterstützung für typabhängige Hervorhebung von Suchergebnissen über CSS. Patch von Tim Hoffmann.

  • #12652: LaTeX: math_numsep-Unterstützung für den LaTeX-Builder hinzugefügt. Patch von Thomas Fanning und Jean-François B.

  • #12743: Kein Beenden mehr bei der ersten Warnung, wenn --fail-on-warning verwendet wird. Stattdessen wird ein von Null verschiedener Status zurückgegeben, wenn während des Builds Warnungen generiert wurden. Patch von Adam Turner.

  • #12743: sphinx-build --exception-on-warning hinzugefügt, um eine Ausnahme auszulösen, wenn während des Builds Warnungen ausgegeben werden. Patch von Adam Turner und Jeremy Maitin-Shepard.

  • #12907: html_last_updated_use_utc hinzugefügt, um die universelle Zeit (GMT/UTC) anstelle der lokalen Zeit für das Datum und die Uhrzeit zu verwenden, die an html_last_updated_fmt übergeben wird. Patch von Adam Turner.

  • #12910: Copyright-Einträge unterstützen jetzt den Platzhalter '%Y', um das aktuelle Jahr zu ersetzen. Dies ist hilfreich, um die Abhängigkeit von Python-Modulen wie time oder datetime in conf.py zu reduzieren. Weitere Details finden Sie in der Dokumentation. Patch von Adam Turner.

  • #11781: Rollen für die Referenzierung von CVEs (:cve:) und CWEs (:cwe:) hinzugefügt. Patch von Hugo van Kemenade.

  • #11809: Verbesserte Formatierung für RFC-Abschnittsanker. Patch von Jakub Stasiak und Adam Turner.

  • #12852: Unterstützung für ein Attribut Builder.supported_linkcode für Builder hinzugefügt, um die Verwendung von durch sphinx.ext.linkcode generierten Referenzen zu ermöglichen. Patch von James Knight.

  • #12949: Konfigurationsoptionen, die sich vom gepickelten Environment unterscheiden, werden ausgegeben. Dies kann bei der Diagnose der Ursache für einen vollständigen Rebuild hilfreich sein. Patch von Adam Turner.

Behobene Fehler

  • #12514: intersphinx: Bedeutung eines negativen Werts für intersphinx_cache_limit korrigiert. Patch von Shengyu Zhang.

  • #12722: LaTeX: Vermeiden von TeX-Meldungen über Overfull \hbox von zu langen Strings in einer Codeline, wenn das Problem dank verbatimforcewraps behoben wurde. Patch von Jean-François B.

  • #12730: Die Transform-Klasse UnreferencedFootnotesDetector wurde verbessert, um nicht referenzierte Fußnoten konsistenter zu erkennen. Hinweis: Die Priorität der Transform wurde von 200 auf 622 geändert, sodass sie jetzt nach der Footnotes-Auflösungstransform von docutils läuft. Patch von Chris Sewell.

  • #12778: LaTeX: ‘sphinxsetup’-Schlüssel div.topic_box-shadow wird bei Verwendung mit nur einer gesetzten Dimension sowohl für den x-Offset als auch für den y-Offset wie in der Dokumentation gesetzt. Patch von Jean-François B.

  • #12587: Keine Warnung bei potenzieller Mehrdeutigkeit während der Intersphinx-Auflösung, die aufgrund doppelter Ziele auftritt, die sich case-insensitiv unterscheiden. Patch von James Addison.

  • #12639: Einzahl- und Mehrzahl-Suchergebnistexte korrigiert. Patch von Hugo van Kemenade.

  • #12645: Benutzerdefinierte gettext-Ausgabe-Templates korrekt unterstützt. Patch von Jeremy Bowman.

  • #12717: LaTeX: Die Option -q (quiet) für sphinx-build -M latexpdf oder make latexpdf (O=-q) wird an latexmk weitergegeben. Die Option -Q (silent) wird auch auf die PDF-Build-Phase angewendet. Patch von Jean-François B.

  • #12744: LaTeX: Klassen, die von einer benutzerdefinierten interpretierten Textrolle injiziert werden, ergeben jetzt verschachtelte \DUrole's statt einer einzigen mit durch Kommas getrennten Klassen. Patch von Jean-François B.

  • #12831: LaTeX: Vermeidung von großen Leerbereichen, die manchmal am Seitenende auftreten. Patch von Jean-François B.

  • #11970, #12551: Singlehtml-Builder: Ziel-URIs werden als Same-Document-Referenzen im Sinne von RFC 3986, §4.4 behandelt, z.B. wird aus index.html#foo #foo. (Hinweis: Fortsetzung eines teilweisen Fixes aus Sphinx 7.3.0) Patch von James Addison (mit Verweis auf frühere Arbeiten von Eric Norige).

  • #12735: LaTeX-Ausgabeformatierung für generische Klassen gemäß PEP 695 korrigiert. Patch von Jean-François B. und Bénédikt Tran.

  • #12782: intersphinx: Doppelte Schrägstriche beim Generieren der Inventory-Datei-URL korrigiert (benutzerdefinierte Basis-URL eines intersphinx-Projekts bleibt unverändert, auch wenn sie mit doppelten Schrägstrichen endet). Patch von Bénédikt Tran.

  • #12796: Paralleles Lesen wird bei Bedarf aktiviert, auch wenn weniger als 6 Dokumente vorhanden sind. Patch von Matthias Geier.

  • #12844: Unterstützung für :noindex: für die Direktiven js:module und py:module wiederhergestellt. Patch von Stephen Finucane.

  • #12916: Unterstützung für benutzerdefinierte Templates, die mit dem Legacy-Suffix _t benannt sind, beim Rendern von apidoc RST wiederhergestellt (Regression in 7.4.0). Patch von James Addison.

  • #12451: Copyright-Hinweisjahre werden nur mit Werten aus SOURCE_DATE_EPOCH für Einträge substituiert, die mit dem aktuellen Systemzeitjahr übereinstimmen, und die Substitution zukünftiger Jahre ist nicht zulässig. Patch von James Addison und Adam Turner.

  • #12905: intersphinx: Falsche Verwendung von intersphinx_cache_limit korrigiert, die den Cache bei positiven Werten immer beibehalten und bei negativen Werten immer aktualisiert hat. Patch von Nico Madysa.

  • #12888: Warnung hinzugefügt, wenn ein Dokument in mehreren Toctree's enthalten ist, und deterministische Auflösung der globalen Toctree in parallelen Builds durch Auswahl des lexikographisch größten übergeordneten Dokuments sichergestellt. Patch von A. Rafey Khan

  • #12995: Deutliche Leistungsverbesserung beim Erstellen des Suchindex für chinesische Sprachen. Patch von Adam Turner.

  • #12767: Builder.write() ist als final typisiert, was bedeutet, dass das Ereignis write-started von Erweiterungen genutzt werden kann. Eine neue Methode Builder.write_documents() wurde hinzugefügt, um zu steuern, wie Dokumente geschrieben werden. Dies ist für Builder gedacht, die keine Datei für jedes Dokument ausgeben. Patch von Adam Turner.

Tests

  • #12141: Migration vom deprecaten JavaScript-Testframework karma zum aktiv gepflegten Framework jasmine. Die Testabdeckung ist nicht betroffen. Patch von James Addison.