Sphinx 3.2

Release 3.2.1 (veröffentlicht am 14. August 2020)

Hinzugefügte Funktionen

  • #8095: napoleon: napoleon_preprocess_types hinzufügen, um den Typ-Präprozessor für Docstrings im Numpy-Stil zu aktivieren

  • #8114: C und C++, Funktionsattribute nach Parametern und Qualifizierern parsen.

Behobene Fehler

  • #8074: napoleon: Abstürze während der Verarbeitung von C-Erweiterungsmodulen

  • #8088: napoleon: Warnung „Inline-Literal-Start-String ohne End-String“ im Abschnitt „Parameter“ im Numpy-Stil

  • #8084: autodoc: KeyError wird ausgelöst, wenn ein Attribut einer fehlerhaften Klasse dokumentiert wird

  • #8091: autodoc: AttributeError wird ausgelöst, wenn ein Attribut auf Python 3.5.2 dokumentiert wird

  • #8099: autodoc: NameError wird ausgelöst, wenn der Zielcode TYPE_CHECKING verwendet

  • C++, Parsing von Template-Template-Parametern korrigieren, was durch die Korrektur von #7944 fehlerhaft wurde

Release 3.2.0 (veröffentlicht am 08. August 2020)

Veraltet

  • sphinx.ext.autodoc.members_set_option()

  • sphinx.ext.autodoc.merge_special_members_option()

  • sphinx.writers.texinfo.TexinfoWriter.desc

  • C, Parsen von Typ-Direktiven und Rollen im pre-v3-Stil, zusammen mit den Optionen c_allow_pre_v3 und c_warn_on_allowed_pre_v3.

Hinzugefügte Features

  • #2076: autodoc: Überschreiben von exclude-members in der Funktion skip-member ermöglichen

  • #8034: autodoc: :private-member: kann eine explizite Liste von Member-Namen für die Dokumentation annehmen

  • #2024: autosummary: autosummary_filename_map hinzufügen, um Konflikte bei Dateinamen zwischen zwei Objekten mit unterschiedlicher Groß-/Kleinschreibung zu vermeiden

  • #8011: autosummary: Instanzattribute als Ziel der autosummary-Direktive unterstützen

  • #7849: html: html_codeblock_linenos_style hinzufügen, um den Stil der Zeilennummern für Codeblöcke zu ändern

  • #7853: C und C++, Unterstützung für parametrisierte GNU-Stil-Attribute.

  • #7888: napoleon: Aliase Warn und Raise hinzufügen.

  • #7690: napoleon: Typ-Strings parsen und sie, wo möglich, zu Hyperlinks machen. Die Konvertierungsregel kann über napoleon_type_aliases aktualisiert werden

  • #8049: napoleon: Hyperlink für jeden Parametertyp erstellen, wenn napoleon_use_param auf False gesetzt ist

  • C, c:alias-Direktive zum Einfügen von Kopien bestehender Deklarationen hinzugefügt.

  • #7745: html: Inventar ist fehlerhaft, wenn der Docname ein Leerzeichen enthält

  • #7991: html-Suche: Ermöglicht die Suche nach Zahlen

  • #7902: html-Theme: Eine neue Option globaltoc_maxdepth hinzufügen, um das Verhalten der globalen Inhaltsübersicht in der Seitenleiste zu steuern

  • #7840: i18n: Abhängigkeitsprüfung beim Bootstrap optimieren

  • #7768: i18n: figure_language_filename unterstützt das Token docpath

  • #5208: linkcheck: Überprüfung lokaler Links unterstützen

  • #5090: setuptools: Verbosity an die Optionen -v und -q von distutils koppeln

  • #6698: doctest: Optionen :trim-doctest-flags: und :no-trim-doctest-flags: zu den Direktiven doctest, testcode und testoutput hinzufügen

  • #7052: :noindexentry: zu den Python-, C-, C++- und Javascript-Domänen hinzufügen. Die Dokumentation aktualisieren, um die Beziehung zwischen dieser Option und der Option :noindex: besser widerzuspiegeln.

  • #7899: C, Möglichkeit des Parsens einiger pre-v3-Stil-Typ-Direktiven und -Rollen hinzugefügt und Versuch, sie in äquivalente v3-Direktiven/Rollen zu konvertieren. Setzen Sie die neue Option c_allow_pre_v3 auf True, um dies zu aktivieren. Die Warnungen, die von dieser Funktionalität ausgegeben werden, können durch Setzen von c_warn_on_allowed_pre_v3 auf True unterdrückt werden. Die Funktionalität ist sofort veraltet.

  • #7999: C, Unterstützung für benannte Variadic-Makroargumente hinzufügen.

  • #8071: Warnung „sich selbst referenzierende Toctrees“ unterdrücken

Behobene Fehler

  • #7886: autodoc: TypeError wird beim Mocking von generisch typisierten Klassen ausgelöst

  • #7935: autodoc: Die Funktionssignatur wird nicht angezeigt, wenn die Funktion einen Parameter hat, dessen Standardwert inspect._empty ist

  • #7901: autodoc: Typ-Annotationen für überladene Funktionen werden nicht aufgelöst

  • #904: autodoc: Ein Instanzattribut verursacht einen Absturz der autofunction-Direktive

  • #1362: autodoc: Die Option private-members funktioniert nicht für Klassenattribute

  • #7983: autodoc: Der Generatortyp-Annotation wird in py36 falsch gerendert

  • #8030: autodoc: Eine nicht initialisierte annotierte Instanzvariable wird nicht dokumentiert, wenn die Option :inherited-members: gegeben ist

  • #8032: autodoc: Eine Typ-Hint für die Instanzvariable, die in der Elternklasse definiert ist, wird im Dokument der abgeleiteten Klasse nicht angezeigt

  • #8041: autodoc: Eine annotierte Instanzvariable in der Oberklasse wird nicht dokumentiert, wenn die abgeleitete Klasse andere annotierte Instanzvariablen hat

  • #7839: autosummary: Umlaute in Funktionsnamen können nicht verarbeitet werden

  • #7865: autosummary: Extraktion der Zusammenfassungszeile fehlgeschlagen, wenn Abkürzungen gefunden wurden

  • #7866: autosummary: Extraktion der korrekten Zusammenfassungszeile fehlgeschlagen, wenn Docstring einen Hyperlink-Ziel enthält

  • #7469: autosummary: Die Überschrift „Modulattribute“ ist nicht übersetzbar

  • #7940: apidoc: Ein zusätzlicher Zeilenumbruch wird am Ende der rst-Datei generiert, wenn ein Modul Untermodule hat

  • #4258: napoleon: dekorierte spezielle Methoden werden nicht angezeigt

  • #7799: napoleon: Parameter werden für kombinierte Parameter in numpydoc nicht escaped

  • #7780: napoleon: Mehrere Parameterdeklarationen in numpydoc wurden falsch erkannt, wenn napoleon_use_param=True

  • #7715: LaTeX: numfig_secnum_depth > 1 führt zu falschen Abbildungslinks

  • #7846: html-Theme: XML-ungültige Dateien wurden generiert

  • #7894: gettext: Falsche Quellinformationen werden angezeigt, wenn rst_epilog verwendet wird

  • #7691: linkcheck: HEAD-Anfragen werden nicht zum Überprüfen verwendet

  • #4888: i18n: Explizite Titel für :ref:-Rolle bei der Übersetzung konnte nicht hinzugefügt werden

  • #7928: py-Domäne: Typ-Annotation für das Attribut konnte nicht aufgelöst werden

  • #8008: py-Domäne: Typ-Annotation, die Ellipsen enthielt, konnte nicht geparst werden

  • #7994: std-Domäne: Option-Direktive generiert keine alten Node-IDs, die mit 2.x oder älter kompatibel sind

  • #7968: i18n: Der Inhalt der math-Direktive wird bei der Übersetzung als reST interpretiert

  • #7768: i18n: Das root-Element für figure_language_filename ist kein Pfad, den der Benutzer im Dokument angibt

  • #7993: texinfo: TypeError wird für verschachtelte Objektbeschreibungen ausgelöst

  • #7993: texinfo: Eine Warnung, die den Node desc_signature_line nicht unterstützt, wird angezeigt

  • #7869: Die abbr-Rolle ohne Erklärung zeigt die Erklärung der vorherigen abbr-Rolle an

  • #8048: graphviz: graphviz.css wurde beim Erstellen von Nicht-HTML-Dokumenten kopiert

  • C und C++, die Option noindex der Direktive wurde entfernt, da sie nichts tat.

  • #7619: Duplizierte Node-IDs werden generiert, wenn ein Node mehrere IDs hat

  • #2050: Symbolabschnitte erscheinen zweimal auf der Indexseite

  • #8017: Zirkulären Import in sphinx.addnodes beheben

  • #7986: CSS: Selektor „highlight“ robuster machen

  • #7944: C++, nicht-Typ-Template-Parameter parsen, die mit einem abhängigen qualifizierten Namen beginnen.

  • C, die gesamte Symboltabelle nicht mehr tiefkopieren und bei der Behandlung eines Enumerators keinen Unsinn anstellen.