Sphinx 7.1

Release 7.1.2 (veröffentlicht am 02. August 2023)

Behobene Fehler

  • #11542: linkcheck: linkcheck_anchors korrekt berücksichtigen und keine fälschlicherweise gemeldeten Fehler bei der Validierung von Ankern. Patch von James Addison.

Release 7.1.1 (veröffentlicht am 27. Juli 2023)

Behobene Fehler

  • #11514: Behebung von SOURCE_DATE_EPOCH in mehrzeiligen Copyright-Fußzeilen. Patch von Bénédikt Tran.

Release 7.1.0 (veröffentlicht am 24. Juli 2023)

Inkompatible Änderungen

Veraltet

  • #11412: Ausgeben von Warnungen bei der Verwendung eines veralteten Python-spezifischen Index-Eintrags-Typs (nämlich module, keyword, operator, object, exception, statement und builtin) in der index-Direktive, und Festlegen der Entfernungsversion auf Sphinx 9. Patch von Adam Turner.

Hinzugefügte Funktionen

  • #11415: Hinzufügen einer Prüfsumme zu JavaScript- und CSS-Asset-URIs, die in generiertem HTML enthalten sind, unter Verwendung des CRC32-Algorithmus.

  • require_sphinx() erlaubt nun die Angabe der Versionsanforderung als (major, minor).

  • #11011: Konfigurierbarkeit einer Zeilenlängenbeschränkung für Objekt-Signaturen über maximum_signature_line_length und die domänenspezifischen Varianten. Wenn die Länge der Signatur (in Zeichen) die konfigurierte Grenze überschreitet, wird jeder Parameter in der Signatur auf eine eigene logische Zeile aufgeteilt. Dieses Verhalten kann auch durch Optionen auf Objektbeschreibungs-Direktiven gesteuert werden, z.B. py:function:single-line-parameter-list. Patch von Thomas Louf, Adam Turner und Jean-François B.

  • #10983: Unterstützung für mehrzeilige Copyright-Anweisungen im Fußzeilenblock. Patch von Stefanie Molin

  • sphinx.util.display.status_iterator löscht nun die aktuelle Zeile mit ANSI-Steuercodes, anstatt sie mit Leerzeichen zu überschreiben.

  • #11431: linkcheck: SSL-Fehler als defekte Links behandeln. Patch von James Addison.

  • #11157: Beibehaltung des Attributs translated auf übersetzten Knoten.

  • #11451: Verbesserung des Tracebacks, der bei der Verwendung von sphinx-build -T in parallelen Builds angezeigt wird. Patch von Bénédikt Tran

  • #11324: linkcheck: Sitzungsbasierte HTTP-Anfragen verwenden.

  • #11438: Unterstützung für die Direktiven py:class und py:function für PEP 695 (generische Klassen- und Funktionsdeklarationen) und PEP 696 (Standard-Typ-Parameter). Mehrzeilige Unterstützung (#11011) ist für Typ-Parameterlisten aktiviert und kann lokal über Objektbeschreibungs-Direktiven gesteuert werden, z.B. py:function:single-line-type-parameter-list. Patch von Bénédikt Tran.

  • #11484: linkcheck: HTML-Anker können pro URL über linkcheck_anchors_ignore_for_url ignoriert werden, während die Gültigkeit der Seite selbst weiterhin überprüft wird. Patch von Bénédikt Tran

  • #1246: Hinzufügen von Statistiken zum Übersetzungsfortschritt und Inspektionsunterstützung, über eine neue Ersetzung (|translation progress|) und eine neue Konfigurationsvariable (translation_progress_classes). Diese ermöglichen die Bestimmung des Prozentsatzes übersetzter Elemente innerhalb eines Dokuments sowie der verbleibenden übersetzten und unübersetzten Elemente.

Behobene Fehler

  • Wiederherstellung der Klasse footnote-reference, die in der neuesten (unveröffentlichten) Version von Docutils entfernt wurde.

  • #11486: Verwendung von Font-Datei-MIME-Typen nach RFC 8081 im EPUB-Builder. Die Verwendung des korrekten MIME-Typs verhindert Warnungen von epubcheck und generiert ein gültiges EPUB.

  • #11435: Verwendung von Zeitstempeln mit Mikrosekundenauflösung für die Erkennung veralteter Dateien in BuildEnvironment.get_outdated_files.

  • #11437: Oberste Überschriften, die mit einer reStructuredText-Rolle beginnen, werden nun korrekt gerendert, wenn rst_prolog gesetzt ist. Zuvor wurde eine Datei, die mit dem unten stehenden beginnt, aufgrund der Einfügung des Prologtextes in das Dokument falsch gerendert.

    :mod:`lobster` -- The lobster module
====================================

...

    Patch von Bénédikt Tran.

  • #11337: Behebung eines MemoryError in sphinx.ext.intersphinx bei Verwendung von None oder typing.* als Inline-Typreferenzen. Patch von Bénédikt Tran (picnixz)

Tests

  • #11345: Immer docutils.conf in Testverzeichnissen löschen, wenn SphinxTestApp.cleanup() ausgeführt wird.