Sphinx 3.4

Release 3.4.3 (veröffentlicht am 08. Jan 2021)

Behobene Fehler

  • #8655: autodoc: Fehler beim Generieren des Dokuments, wenn das Zielmodul ein Objekt enthält, das eine Ausnahme bei hasattr() auslöst

Release 3.4.2 (veröffentlicht am 04. Jan 2021)

Behobene Fehler

  • #8164: autodoc: Klassen, die eine gemockte Klasse erben, werden nicht dokumentiert

  • #8602: autodoc: Das Ereignis autodoc-process-docstring wird unerwartet für Nicht-Datadescriptoren ausgelöst

  • #8616: autodoc: AttributeError wird ausgelöst, wenn ein Nicht-Klassenobjekt an die autoclass-Direktive übergeben wird

Release 3.4.1 (veröffentlicht am 25. Dez 2020)

Behobene Fehler

  • #8559: autodoc: AttributeError wird beim Verwenden von Forward-Reference-Typannotationen ausgelöst

  • #8568: autodoc: TypeError wird beim Prüfen des Slots-Attributs ausgelöst

  • #8567: autodoc: Instanzattribute werden fälschlicherweise zur Elternklasse hinzugefügt

  • #8566: autodoc: Das Ereignis autodoc-process-docstring wird unerwartet für Alias-Klassen ausgelöst

  • #8583: autodoc: Unnötiger Objektvergleich über die __eq__-Methode

  • #8565: linkcheck: Behebung eines PriorityQueue-Absturzes, wenn Link-Tupel nicht vergleichbar sind

Release 3.4.0 (veröffentlicht am 20. Dez 2020)

Inkompatible Änderungen

  • #8105: autodoc: Die Signatur des Klassenkonstruktors wird für dekorierte Klassen angezeigt, nicht die Signatur des Dekorators

Veraltet

  • Das follow_wrapped-Argument von sphinx.util.inspect.signature()

  • Das no_docstring-Argument von sphinx.ext.autodoc.Documenter.add_content()

  • sphinx.ext.autodoc.Documenter.get_object_members()

  • sphinx.ext.autodoc.DataDeclarationDocumenter

  • sphinx.ext.autodoc.GenericAliasDocumenter

  • sphinx.ext.autodoc.InstanceAttributeDocumenter

  • sphinx.ext.autodoc.SlotsAttributeDocumenter

  • sphinx.ext.autodoc.TypeVarDocumenter

  • sphinx.ext.autodoc.importer._getannotations()

  • sphinx.ext.autodoc.importer._getmro()

  • sphinx.pycode.ModuleAnalyzer.parse()

  • sphinx.util.osutil.movefile()

  • sphinx.util.requests.is_ssl_error()

Hinzugefügte Funktionen

  • #8119: autodoc: Ermöglicht zu bestimmen, ob ein Mitglied, das nicht im Attribut __all__ des Moduls enthalten ist, über das Ereignis autodoc-skip-member dokumentiert werden soll oder nicht

  • #8219: autodoc: Parameter für generische Klassen werden nicht angezeigt, wenn die Superklasse eine generische Klasse ist und die Option show-inheritance gegeben ist (in Python 3.7 oder höher)

  • autodoc: Documenter.config als Abkürzung zum Zugriff auf das Konfigurationsobjekt hinzugefügt

  • autodoc: Optional[t] zur Annotation von Funktionen und Methoden hinzugefügt, wenn ein Standardwert gleich None gesetzt ist.

  • #8209: autodoc: :no-value:-Option zur autoattribute- und autodata-Direktive hinzugefügt, um den Standardwert der Variable zu unterdrücken

  • #8460: autodoc: Unterstützung für benutzerdefinierte Typen, die von typing.NewType definiert wurden

  • #8285: napoleon: napoleon_attr_annotations hinzugefügt, um Typ-Hints im Quellcode automatisch zusammenzuführen, wenn ein Typ in der Docstring angegeben ist

  • #8236: napoleon: Unterstützung für numpydoc's „Receives“-Abschnitt

  • #6914: Neues Ereignis warn-missing-reference hinzugefügt, um benutzerdefinierte Warnmeldungen zu erstellen, wenn eine Querverweisauflösung fehlschlägt

  • #6914: Detaillierte Warnung ausgegeben, wenn ein :ref:-Verweis nicht aufgelöst werden kann

  • #6629: linkcheck: Der Builder behandelt jetzt Ratenbegrenzungen. Weitere Details finden Sie unter linkcheck_rate_limit_timeout.

Behobene Fehler

  • #7613: autodoc: autodoc respektiert nicht die __signature__ der Klasse

  • #4606: autodoc: der Speicherort der Warnung ist für geerbte Methoden falsch

  • #8105: autodoc: die Signatur des Klassenkonstruktors ist falsch, wenn die Klasse dekoriert ist

  • #8434: autodoc: autodoc_type_aliases wirkt sich nicht auf Variablen und Attribute aus

  • #8443: autodoc: Die autodata-Direktive kann kein Dokument für PEP-526-basierte Typ-annotierte Variablen erstellen

  • #8443: autodoc: Die autoattribute-Direktive kann kein Dokument für uninitialisierte Variablen erstellen, die auf PEP-526 basieren

  • #8480: autodoc: autoattribute konnte kein Dokument für __slots__-Attribute erstellen

  • #8503: autodoc: autoattribute konnte kein Dokument für einen GenericAlias als Klassenattribut korrekt erstellen

  • #8534: autodoc: autoattribute konnte kein Dokument für ein auskommentiertes Attribut in einer Aliasklasse erstellen

  • #8452: autodoc: autodoc_type_aliases funktioniert nicht, wenn autodoc_typehints auf "description" gesetzt ist

  • #8541: autodoc: autodoc_type_aliases funktioniert nicht für die Typannotation von Instanzattributen

  • #8460: autodoc: Die Direktiven autodata und autoattribute zeigen keine Typinformationen von TypeVars an

  • #8493: autodoc: Referenzen auf Builtins funktionieren nicht in Klassen-Aliase

  • #8522: autodoc: die __bool__-Methode könnte aufgerufen werden

  • #8067: autodoc: Ein Typehint für die Instanzvariable mit type_comment in der Superklasse wird nicht angezeigt

  • #8545: autodoc: ein __slots__-Attribut wird nicht dokumentiert, auch wenn es eine Docstring hat

  • #741: autodoc: inherited-members funktioniert nicht für Instanzattribute der Superklasse

  • #8477: autosummary: Nicht-UTF-8-reST-Dateien werden generiert, wenn eine Vorlage Mehrbytezeichen enthält

  • #8501: autosummary: Die Zusammenfassungsextraktion teilt Text nach „el at.“ unerwartet auf

  • #8524: html: Falscher url_root wurde für ein Dokument namens „index“ generiert

  • #8419: html-Suche: language_data.js wird auf Nicht-Suchseiten nicht geladen

  • #8549: i18n: -D gettext_compact=0 funktioniert nicht mehr

  • #8454: graphviz: Die Layout-Option für graph- und digraph-Direktiven funktioniert nicht

  • #8131: linkcheck: GET verwenden, wenn HEAD-Anfragen Too Many Redirects verursachen, um unendliche Weiterleitungsschleifen bei HEAD zu berücksichtigen

  • #8437: Makefile: make clean mit leerem BUILDDIR ist gefährlich

  • #8365: py domain: :type: und :rtype: geben falsche, mehrdeutige Klassensuche-Warnungen aus

  • #8352: std domain: Fehler beim Parsen einer Option, die mit einer Klammer beginnt

  • #8519: LaTeX: Seitenumbruch in der Mitte eines seealso verhindern

  • #8520: C, Kopieren von AliasNode korrigiert.