Sphinx 2.4

Release 2.4.5 (veröffentlicht am 18. Nov. 2021)

Abhängigkeiten

  • #9807: Docutils auf 0.17.x oder älter beschränken

Release 2.4.4 (veröffentlicht am 05. Mrz. 2020)

Behobene Fehler

  • #7197: LaTeX: platex verursacht Fehler beim Erstellen der Bilddirektive mit Ziel-URL

  • #7223: Sphinx-Builds sind seit 2.4.0 langsamer geworden

Release 2.4.3 (veröffentlicht am 22. Feb. 2020)

Behobene Fehler

  • #7184: autodoc: *args und **kwarg in Typ-Kommentaren werden nicht richtig behandelt

  • #7189: autodoc: Classmethod-Coroutinen werden nicht erkannt

  • #7183: intersphinx: :attr:-Referenz zu einer Eigenschaft ist defekt

  • #6244, #6387: html Suche: Suche bricht ab/hängt, wenn mit dem dirhtml-Builder erstellt

  • #7195: todo: doctree-resolved Event mit nicht-Dokumenten-Knoten falsch emittieren

Release 2.4.2 (veröffentlicht am 19. Feb. 2020)

Behobene Fehler

  • #7138: autodoc: autodoc.typehints stürzt ab, wenn eine Variable ein ungebundenes Objekt als Wert hat

  • #7156: autodoc: Trennzeichen für ausschließlich Schlüsselwortargumente wird nicht angezeigt

  • #7146: autodoc: IndexError wird ausgelöst bei unterdrücktem gefundenem type_comment

  • #7161: autodoc: typehints-Erweiterung unterstützt kein paralleles Erstellen

  • #7178: autodoc: TypeError wird beim Abrufen von Typ-Annotationen ausgelöst

  • #7151: Absturz, wenn eine Erweiterung einen Wert für env.indexentries zuweist

  • #7170: text: Debug-Print entfernen

  • #7137: viewcode: Absturz vermeiden, wenn nicht-Python-Code gegeben wird

Release 2.4.1 (veröffentlicht am 11. Feb. 2020)

Behobene Fehler

  • #7120: html: Absturz beim Skalieren von SVG-Bildern mit Gleitkomma-Dimensionen

  • #7126: autodoc: TypeError: ‘getset_descriptor’ object is not iterable

Release 2.4.0 (veröffentlicht am 09. Feb. 2020)

Veraltet

  • Das decode-Argument von sphinx.pycode.ModuleAnalyzer()

  • sphinx.directives.other.Index

  • sphinx.environment.temp_data['gloss_entries']

  • sphinx.environment.BuildEnvironment.indexentries

  • sphinx.environment.collectors.indexentries.IndexEntriesCollector

  • sphinx.ext.apidoc.INITPY

  • sphinx.ext.apidoc.shall_skip()

  • sphinx.io.FiletypeNotFoundError

  • sphinx.io.get_filetype()

  • sphinx.pycode.ModuleAnalyzer.encoding

  • sphinx.roles.Index

  • sphinx.util.detect_encoding()

  • sphinx.util.get_module_source()

  • sphinx.util.inspect.Signature

  • sphinx.util.inspect.safe_getmembers()

  • sphinx.writers.latex.LaTeXTranslator.settings.author

  • sphinx.writers.latex.LaTeXTranslator.settings.contentsname

  • sphinx.writers.latex.LaTeXTranslator.settings.docclass

  • sphinx.writers.latex.LaTeXTranslator.settings.docname

  • sphinx.writers.latex.LaTeXTranslator.settings.title

  • sphinx.writers.latex.ADDITIONAL_SETTINGS

  • sphinx.writers.latex.DEFAULT_SETTINGS

  • sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG

  • sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG

  • sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG

  • sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG

Hinzugefügte Funktionen

  • #6910: inheritance_diagram: Hintergrund von Diagrammen transparent machen

  • #6446: duration: sphinx.ext.durations hinzufügen, um zu inspizieren, welche Dokumente den Build verlangsamen

  • #6837: LaTeX: Verschachtelte Tabelle unterstützen

  • #7115: LaTeX: LATEXOPTS und LATEXMKOPTS über Umgebungsvariable überschreiben lassen

  • #6966: graphviz: :class:-Option unterstützen

  • #6696: html: :scale:-Option der Bild-/Figuren-Direktive funktioniert nicht für SVG-Bilder (imagesize-1.2.0 oder höher erforderlich)

  • #6994: imgconverter: Unterstützung der Konvertierung von Illustrator-Dateien (.ai) in .png

  • autodoc: Unterstützung für Positional-Only-Argument-Trennzeichen (PEP-570 konform)

  • autodoc: Unterstützung für Typ-Annotationen für Variablen

  • #2755: autodoc: Neues Event hinzufügen: autodoc-before-process-signature

  • #2755: autodoc: Unterstützung für Typ-Kommentar-Stil (z. B. # type: (str) -> str) Annotation (python3.8+ oder typed_ast erforderlich)

  • #7051: autodoc: Unterstützung für Instanzvariablen ohne Standardwerte (PEP-526)

  • #6418: autodoc: Neue Erweiterung sphinx.ext.autodoc.typehints hinzufügen. Sie zeigt Typ-Hinweise als Objektbeschreibung an, wenn autodoc_typehints = "description" gesetzt ist. Dies ist eine experimentelle Erweiterung und wird in Sphinx 3.0 in den autodoc-Kern integriert

  • SphinxTranslator ruft jetzt die Besucher-/Absendemethoden für die übergeordnete Knotenkalsse auf, wenn keine Besucher-/Absendemethoden für die ursprüngliche Knotenkalsse gefunden werden

  • #6418: Neues Event hinzufügen: object-description-transform

  • py-Domäne: py:data und py:attribute nehmen neue Optionen namens :type: und :value:, um ihren Typ und Anfangswert zu beschreiben

  • #6785: py-Domäne: :py:attr: kann wieder auf Eigenschaften verweisen

  • #6772: apidoc: -q-Option für den Still-Modus hinzufügen

Behobene Fehler

  • #6925: html: Redundantes type=”text/javascript” aus <script>-Elementen entfernen

  • #7112: html: SVG-Bild wird nicht als float layoiert, auch wenn es ausgerichtet ist

  • #6906, #6907: autodoc: Konnte Quellcodes mit cp1251-Kodierung nicht lesen

  • #6961: latex: Warnung für Babel wird zweimal angezeigt

  • #7059: latex: LaTeX-Kompilierung gerät in eine Endlosschleife (wrapfig-Problem)

  • #6581: latex: :reversed:-Option für toctree hat keine Auswirkung auf den LaTeX-Build

  • #6559: Falsche Knoten-IDs werden in der Glossar-Direktive generiert

  • #6986: apidoc: Modulname für .so-Datei innerhalb eines Moduls wird falsch erkannt

  • #6899: apidoc: Private Mitglieder werden nicht angezeigt, auch wenn --private angegeben ist

  • #6327: apidoc: Unterstützung für ein Python-Paket, das eine __init__.so-Datei enthält

  • #6999: napoleon: scheitert beim Parsen von Tilden in :exc:-Rollen

  • #7019: gettext: Absoluter Pfad in Nachrichten-Katalogen verwendet

  • #7023: autodoc: Verschachtelte Teilfunktionen werden nicht aufgelistet

  • #7023: autodoc: Teilfunktionen, die aus anderen Modulen importiert werden, werden ohne Option :imported-members: als Modulmitglieder aufgelistet

  • #6889: autodoc: Abschließendes Komma in der Option :members:: verursacht eine kryptische Warnung

  • #6568: autosummary: autosummary_imported_members wird bei der Generierung einer Stubdatei für ein Untermodul ignoriert

  • #7055: linkcheck: Umleitung wird als Fehler behandelt

  • #7088: HTML-Vorlage: Wenn die Option navigation_with_keys aktiviert ist, werden Modifikatortasten ignoriert, was dazu führt, dass das Feature mit Browserfunktionen kollidiert

  • #7090: std-Domäne: Nummern können nicht für benutzerdefinierte Containerknoten zugewiesen werden

  • #7106: std-Domäne: Aufzählungsknoten werden als Duplikate markiert, wenn Erweiterungen note_explicit_target() aufrufen

  • #7095: dirhtml: Querverweise sind über intersphinx und die :doc:-Rolle defekt

  • C++

    • Keine Abstürze mehr bei der Verwendung der struct-Rolle in einigen Fällen.

    • Keine Warnungen mehr bei der Verwendung der var/member-Rolle für Funktionsparameter.

    • Aufrufe und mit Klammern versehene Initialisierungs-Ausdrücke korrekt rendern.

  • #7097: Dateinamen von Bildern, die von sphinx.transforms.post_transforms.images.ImageConverter oder deren Unterklassen (verwendet für LaTeX-Build) generiert werden, werden jetzt bereinigt, um fehlerhafte Pfade zu verhindern