Sphinx 4.4

Release 4.4.0 (veröffentlicht am 17. Januar 2022)

Abhängigkeiten

  • #10007: Verwende importlib_metadata für python-3.9 oder älter

  • #10007: Entferne setuptools

Hinzugefügte Funktionen

  • #9075: autodoc: Füge eine Konfigurationsvariable autodoc_typehints_format hinzu, um die führenden Modulnamen von Typ-Hints von Funktionssignaturen zu unterdrücken (z. B. io.StringIO -> StringIO)

  • #9831: Autosummary dokumentiert jetzt nur die in einem Modul definierten Mitglieder __all__ Attribut, wenn autosummary_ignore_module_all auf False gesetzt ist. Das Standardverhalten bleibt unverändert. Autogen unterstützt dieses Verhalten jetzt auch mit dem Schalter --respect-module-all.

  • #9555: autosummary: Verbessere Fehlermeldungen bei fehlgeschlagenem Laden des Zielobjekts

  • #9800: extlinks: Gib eine Warnung aus, wenn ein hartcodierter Link durch einen extlink ersetzt werden kann, und schlage eine Ersetzung vor.

  • #9961: html: Unterstütze verschachtelte <kbd> HTML-Elemente in anderen HTML-Buildern

  • #10013: html: Erlaube die Änderung der Ladeart von JS über den Parameter loading_method für Sphinx.add_js_file()

  • #9551: html-Suche: Der Link „Suchergebnisse ausblenden“ entfernt den Parameter „highlight“ aus der URL

  • #9815: html-Theme: Wickle Sidebar-Komponenten in eine Div ein, um deren Layout über CSS anpassen zu können

  • #9827: i18n: Sortiere Einträge im Glossar nach übersetzten Begriffen

  • #9899: py-Domain: Erlaube die Angabe von Cross-Reference-Specifiern (. und ~) als Option :type:

  • #9894: linkcheck: Füge die Option linkcheck_exclude_documents hinzu, um die Linkprüfung in übereinstimmenden Dokumenten zu deaktivieren.

  • #9793: sphinx-build: Erlaube die Nutzung der parallelen Build-Funktion unter macOS auf macOS und Python3.8+

  • #10055: sphinx-build: Erstelle Verzeichnisse, wenn die Option -w gegeben ist

  • #9993: std-Domain: Erlaube das Verweisen auf ein Inline-Ziel (z. B. _`ziel name`) über die Rolle ref

  • #9981: std-Domain: Entferne den Wertteil der Optionsdirektive aus dem allgemeinen Index

  • #9391: texinfo: Verbessere Variable in der Rolle samp

  • #9578: texinfo: Füge texinfo_cross_references hinzu, um Cross-References zur Lesbarkeit bei Standalone-Readern zu deaktivieren

  • #9822, #9062: Füge eine neue Intersphinx-Rolle external für explizite Lookups in externen Projekten hinzu, ohne auf das lokale Projekt aufzulösen.

Behobene Fehler

  • #9866: autodoc: Doccomment für die importierte Klasse wurde ignoriert

  • #9883: autodoc: Doccomment für den Alias eines gemockten Objekts wurde ignoriert

  • #9908: autodoc: Debug-Nachricht wird angezeigt, wenn ein Dokument mit NewTypes unter Python 3.10 erstellt wird

  • #9968: autodoc: Instanzvariablen werden nicht angezeigt, wenn die Methode `__init__` positionsbasierte Argumente hat

  • #9194: autodoc: Typen unter dem Modul „typing“ sind nicht verlinkt

  • #10009: autodoc: Absturz, wenn das Zielobjekt beim Abrufen des Docstrings einen Fehler auslöst

  • #10058: autosummary: Importierte Mitglieder werden nicht angezeigt, wenn autodoc_class_signature = 'separated'

  • #9947: i18n: Topic-Direktive mit einer Aufzählungsliste kann nicht übersetzt werden

  • #9878: mathjax: MathJax-Konfiguration wird nach dem Laden von MathJax selbst platziert

  • #9932: napoleon: Ein leerer „returns“-Abschnitt wird generiert, auch wenn keine Beschreibung vorhanden ist

  • #9857: Generierte RFC-Links verwenden eine veraltete Basis-URL

  • #9909: HTML, verhindere Zeilenumbrüche in Literaltext.

  • #10061: html-Theme: Konfigurationswerte, die von Themes hinzugefügt wurden, können nicht aus conf.py überschrieben werden

  • #10073: imgconverter: Unnötige Verfügbarkeitsprüfung wird für „data“-URIs aufgerufen

  • #9925: LaTeX: Verhindere auch mit 'xelatex' Zeilenumbrüche bei Bindestrichen von Inline- und geparsten Literalen

  • #9944: LaTeX: Zusätzlicher vertikaler Leerraum für einige verschachtelte Deklarationen

  • #9940: LaTeX: Mehrfachfunktionsdeklaration in der Python-Domäne hat gequetschten vertikalen Abstand in der Latexpdf-Ausgabe

  • #10015: py-Domain: Typen unter dem „typing“-Modul sind nicht verlinkt, die in der Info-Feldliste definiert sind

  • #9390: texinfo: Gib keine Labels innerhalb von Fußnoten aus

  • #9413: xml: Ungültiges XML wurde generiert, wenn Python-Objekte referenziert wurden

  • #9979: Nachrichten auf Fehlerebene wurden als Warnmeldungen angezeigt

  • #10057: Dokumente konnten nicht gescannt werden, wenn das Projekt im Stammverzeichnis platziert war

  • #9636: code-block: :dedent: ohne Argument hat neue Zeilen gestrippt