Sphinx 4.1

Release 4.1.2 (veröffentlicht am 27. Juli 2021)

Inkompatible Änderungen

  • #9435: linkcheck: Deaktiviert die Überprüfung von automatisch generierten Ankern auf github.com (z. B. Anker in reST/Markdown-Dokumenten)

Behobene Fehler

  • #9489: autodoc: Benutzerdefinierte Typen, die typing.NewType verwenden, werden mit dem HEAD von 3.10 nicht gut angezeigt

  • #9490: autodoc: Einige Objekte im typing-Modul werden mit dem HEAD von 3.10 nicht gut angezeigt

  • #9436, #9471: autodoc: abgestürzt, wenn autodoc_class_signature = "separated"

  • #9456: html search: html_copy_source kann die Suchzusammenfassungen nicht steuern

  • #9500: LaTeX: Fehler beim Erstellen japanischer Dokumente unter Windows

  • #9435: linkcheck: Fehler beim Überprüfen von Ankern in github.com

Release 4.1.1 (veröffentlicht am 15. Juli 2021)

Abhängigkeiten

  • #9434: sphinxcontrib-htmlhelp-2.0.0 oder höher

  • #9434: sphinxcontrib-serializinghtml-1.1.5 oder höher

Behobene Fehler

  • #9438: html: HTML-Logo oder Favicon, die als Datei angegeben sind, werden in der Ausgabe nicht gefunden

Release 4.1.0 (veröffentlicht am 12. Juli 2021)

Abhängigkeiten

  • Unterstützt jinja2-3.0

Veraltet

  • Das app-Argument von sphinx.environment.BuildEnvironment wird erforderlich

  • sphinx.application.Sphinx.html_theme

  • sphinx.ext.autosummary._app

  • sphinx.util.docstrings.extract_metadata()

Hinzugefügte Funktionen

  • #8107: autodoc: Fügt die Option class-doc-from zur autoclass-Direktive hinzu, um den Inhalt der spezifischen Klasse zu steuern, ähnlich wie bei autoclass_content

  • #8588: autodoc: autodoc_type_aliases unterstützt jetzt Punktnotation. Dies ermöglicht die Definition eines Alias für eine Klasse mit Modulnamen wie foo.bar.BazClass

  • #9175: autodoc: Spezielle Member werden im Modul nicht dokumentiert

  • #9195: autodoc: Die Argumente von typing.Literal werden falsch gerendert

  • #9185: autodoc: autodoc_typehints erlaubt die Einstellung 'both', um Typenhinweise sowohl in der Signatur als auch in der Beschreibung einzuschließen

  • #4257: autodoc: Fügt autodoc_class_signature hinzu, um den Klasseneintrag und die Definition der __init__()-Methode zu trennen

  • #8061, #9218: autodoc: Unterstützt Variablenkommentare für Alias-Klassen

  • #3014: autodoc: Fügt autodoc-process-bases hinzu, um die Basisklassen von Klassendefinitionen zu ändern

  • #9272: autodoc: Enum-Werte für Standardargumentwerte besser rendern

  • #9384: autodoc: autodoc_typehints='none' löscht nun Typenhinweise für Variablen, Attribute und Eigenschaften

  • #3257: autosummary: Unterstützt Instanzattribute für Klassen

  • #9358: html: Fügt die Rolle „heading“ zu den toctree-Elementen hinzu

  • #9225: html: Fügt einen Span-Tag zum Rückgabe-Typenhinweis von Methoden/Funktionen hinzu

  • #9129: html search: Zeigt Suchzusammenfassungen an, wenn html_copy_source = False

  • #9307: html search: Verhindert Korrekturen und Vervollständigungen im Suchfeld

  • #9120: html theme: Entfernt Prompt-Zeichen von Code-Blöcken aus kopierbarem Text

  • #9176: i18n: Gibt eine Debug-Nachricht aus, wenn die Nachrichtenkatalogdatei nicht unter locale_dirs gefunden wird

  • #9414: LaTeX: Fügt xeCJKVerbAddon zur Standard-fvset-Konfiguration für chinesische Dokumente hinzu

  • #9016: linkcheck: Unterstützt die Überprüfung von Ankern auf github.com

  • #9016: linkcheck: Fügt ein neues Ereignis linkcheck-process-uri hinzu, um URIs vor der Überprüfung von Hyperlinks zu ändern

  • #6525: linkcheck: Fügt linkcheck_allowed_redirects hinzu, um Hyperlinks, die auf erwartete URLs umgeleitet werden, als „funktionierend“ zu markieren

  • #1874: py domain: Unterstützt Union-Typen mit | in der Info-Feldliste

  • #9268: py domain: python_use_unqualified_type_names unterstützt das Typenfeld in der Info-Feldliste

  • #9097: Optimiert den parallelen Build

  • #9131: Fügt nitpick_ignore_regex hinzu, um nitpicky-Warnungen mithilfe von regulären Ausdrücken zu ignorieren

  • #9174: Fügt Sphinx.set_html_assets_policy hinzu, um Erweiterungen anzuweisen, HTML-Assets auf allen Seiten einzuschließen. Erweiterungen können dies über Sphinx.registry.html_assets_policy überprüfen

  • C++, Unterstützung für

    • inline-Variablen,

    • consteval-Funktionen,

    • constinit-Variablen,

    • char8_t,

    • explicit(<konstanter Ausdruck>)-Spezifizierer,

    • Zifferntrenner in Literalen und

    • Einschränkungen in Platzhalter-Typspezifizierern, auch bekannt als Adjektiv-Syntax (z. B. Sortable auto &v).

  • C, Unterstützung für Zifferntrenner in Literalen hinzugefügt.

  • #9166: LaTeX: Unterstützung für Container in LaTeX-Ausgabe

Behobene Fehler

  • #8872: autodoc: gestapelte „singledispatches“ werden falsch gerendert

  • #8597: autodoc: ein Docstring, der nur Metadaten enthält, sollte als undokumentiert behandelt werden

  • #9185: autodoc: Typenhinweise für überladene Funktionen und Methoden sind ungenau

  • #9250: autodoc: Die geerbte Methode ohne Docstring wird falsch geparst

  • #9283: autodoc: Die Direktive autoattribute konnte kein Dokument für ein Attribut ohne Kommentar generieren

  • #9364: autodoc: Einzige Elemente in Tupeln für Standard-Argumentwerte werden falsch gerendert

  • #9362: autodoc: AttributeError wird bei der Verarbeitung einer Unterklasse von Tuple[()] ausgelöst

  • #9404: autodoc: TypeError wird bei der Verarbeitung eines Wörterbuch-ähnlichen Objekts (keine Klasse) über die autoclass-Direktive ausgelöst

  • #9317: html: Das Drücken der linken Pfeiltaste führt beim ersten Seitenbesuch zur nächsten Seite

  • #9381: html: URL für html_favicon und html_log funktioniert nicht

  • #9270: html theme: das Pyramid-Theme generiert falsche Logo-Links

  • #9217: manpage: Der Name des Manpage-Verzeichnisses, das von man_make_section_directory generiert wird, ist nicht korrekt

  • #9350: manpage: Schrift wird nach Schlüssel am Anfang der samp-Rolle nicht zurückgesetzt

  • #9306: Linkcheck meldet einen defekten Link, wenn der Remote-Server die Verbindung bei einer HEAD-Anfrage schließt

  • #9280: py domain: Das Modul „exceptions“ wird nicht angezeigt

  • #9418: py domain: Eine Callable-Annotation ohne Parameter (z. B. Callable[[], None]) wird mit einer fehlenden Klammer gerendert (Callable[], None])

  • #9319: quickstart: Beendet sphinx-quickstart, wenn conf.py bereits existiert

  • #9387: xml: XML Builder ignoriert benutzerdefinierte Besucher

  • #9224: :param: und :type: Felder unterstützen keinen Typ, der Leerzeichen enthält (z. B. Dict[str, str])

  • #8945: Beim Transformieren von Typfeldern wird die angegebene Rolle aufgerufen, anstatt nur einen Verweis zu erstellen. Für C und C++ wird die expr-Rolle für Typfelder verwendet.