Sphinx 3.0

Release 3.0.4 (veröffentlicht am 27. Mai 2020)

Behobene Fehler

  • #7567: autodoc: parametrisierte Typen werden für generische Typen doppelt angezeigt

  • #7637: autodoc: Systemdefinierte TypeVars werden in Python 3.9 angezeigt

  • #7696: html: jQuery-Version aus Sicherheitsgründen von 3.4.1 auf 3.5.1 aktualisiert

  • #7611: md5 schlägt fehl, wenn OpenSSL FIPS aktiviert ist

  • #7626: Release-Paket enthält keine CODE_OF_CONDUCT

Release 3.0.3 (veröffentlicht am 26. Apr. 2020)

Hinzugefügte Funktionen

  • C, Parsen von Array-Deklaratoren mit statischen, qualifizierenden und VLA-Spezifikationen.

Behobene Fehler

  • #7516: autodoc: stürzt ab, wenn das Zielobjekt beim Zugriff auf seine Attribute einen Fehler auslöst

Release 3.0.2 (veröffentlicht am 19. Apr. 2020)

Hinzugefügte Funktionen

Behobene Fehler

  • #7461: py-Domäne: schlägt mit IndexError bei leerem Tupel in Typannotation fehl

  • #7510: py-Domäne: Keyword-only-Argumente werden als mit einem Standardwert von None dokumentiert

  • #7418: std-Domäne: Die term-Rolle konnte nicht case-insensitiv übereinstimmen

  • #7461: autodoc: leeres Tupel in Typannotation wird nicht korrekt angezeigt

  • #7479: autodoc: Sphinx-Builds sind seit 3.0.0 beim Mocking langsamer geworden

  • C++, Korrektur des Abstandsfehlers in East-Const-Deklarationen.

  • #7414: LaTeX: Xindy-Sprachoptionen waren falsch

  • Sphinx stürzt bei ImportError auf python3.5.1 ab

Release 3.0.1 (veröffentlicht am 11. Apr. 2020)

Inkompatible Änderungen

  • #7418: std-Domäne: Die term-Rolle wird case-sensitiv

Behobene Fehler

  • #7428: py-Domäne: Ein Verweis auf die Klasse None gibt eine sehr genaue Warnung aus

  • #7445: py-Domäne: Eine Rückgabe-Annotation None in der Funktionssignatur wird nicht in einen Hyperlink konvertiert, wenn Intersphinx verwendet wird

  • #7418: std-Domäne: Duplizierte Warnung für Glossarbegriffe ist case-insensitiv

  • #7438: C++, Korrektur der Zusammenführung überladener Funktionen in parallelen Builds.

  • #7422: autodoc: schlägt mit ValueError bei Verwendung von autodoc_mock_imports fehl

  • #7435: autodoc: autodoc_typehints='description' unterdrückt keine Typenhinweise in der Signatur für Klassen/Methoden

  • #7451: autodoc: schlägt mit AttributeError fehl, wenn ein Objekt bei seinem __doc__-Member ein Nicht-String-Objekt zurückgibt

  • #7423: Absturz beim Übergeben eines Nicht-String-Objekts an den Logger

  • #7479: html-Theme: xmlns-Attribut mit HTML 5 Doctype nicht einschließen

  • #7426: html-Theme: Einige Links in HTML-Vorlagen maskieren

Release 3.0.0 (veröffentlicht am 06. Apr. 2020)

Abhängigkeiten

3.0.0b1

  • LaTeX: Abhängigkeit von extractbb für die Einbindung von Bildern in japanische Dokumente entfernt, da .xbb-Dateien seit TeXLive2015 von dvipdfmx nicht mehr benötigt werden (refs: #6189)

  • babel-2.0 oder höher ist verfügbar (nicht fixiert)

Inkompatible Änderungen

3.0.0b1

  • Entfernung von in 1.8.x abgekörterten Funktionen und APIs

  • #247: autosummary: Stub-Dateien werden standardmäßig automatisch überschrieben. siehe autosummary_generate_overwrite, um das Verhalten zu ändern

  • #5923: autodoc: Die Mitglieder der Klasse object werden standardmäßig nicht dokumentiert, wenn :inherited-members: und :special-members: angegeben sind.

  • #6830: py-Domäne: meta-Felder in Info-Field-List werden reserviert. Sie werden jetzt nicht mehr im Ausgabedokument angezeigt

  • #6417: py-Domäne: Der Doctree von desc_parameterlist wurde geändert. Die Argumentnamen, Annotationen und Standardwerte werden mit Inline-Knoten umschlossen

  • Die Struktur von sphinx.events.EventManager.listeners hat sich geändert

  • Aufgrund von Scoping-Änderungen für die productionlist-Direktive müssen einige Verwendungen der token-Rolle modifiziert werden, um den Gültigkeitsbereich einzuschließen, der zuvor ignoriert wurde.

  • #6903: Interne Datenstruktur von Python-, reST- und Standarddomänen hat sich geändert. Die node_id wird dem Index von Objekten und Modulen hinzugefügt. Jetzt enthalten sie ein Paar aus docname und node_id für Querverweise.

  • #7276: C++-Domäne: Nicht beabsichtigtes Verhalten wurde entfernt, wie z. B. say_hello_ Links zu .. cpp:function:: say_hello()

  • #7210: js-Domäne: Nicht beabsichtigtes Verhalten wurde entfernt, wie z. B. parseInt_ Links zu .. js:function:: parseInt

  • #7229: rst-Domäne: Nicht beabsichtigtes Verhalten wurde entfernt, wie z. B. numref_ Links zu .. rst:role:: numref

  • #6903: py-Domäne: Nicht beabsichtigtes Verhalten wurde entfernt, wie z. B. say_hello_ Links zu .. py:function:: say_hello()

  • #7246: py-Domäne: Speziellen Querverweis-Helfer für Ausnahmen, Funktionen und Methoden entfernt

  • Die C-Domäne wurde neu geschrieben, mit zusätzlichen Direktiven und Rollen. Die vorhandenen sind jetzt strenger, was zu neuen Warnungen führt.

  • Das Attribut sphinx_cpp_tagname im desc_signature_line-Knoten wurde in sphinx_line_type umbenannt.

  • #6462: Doppelte Backslashes in Domänen-Direktiven werden standardmäßig nicht mehr durch einzelne Backslashes ersetzt. Ein neuer Konfigurationswert strip_signature_backslash kann von Benutzern verwendet werden, um ihn wieder zu aktivieren.

3.0.0 final

  • #7222: sphinx.util.inspect.unwrap() wurde in unwrap_all() umbenannt

Veraltet

3.0.0b1

  • desc_signature['first']

  • sphinx.directives.DescDirective

  • sphinx.domains.std.StandardDomain.add_object()

  • sphinx.domains.python.PyDecoratorMixin

  • sphinx.ext.autodoc.get_documenters()

  • sphinx.ext.autosummary.process_autosummary_toc()

  • sphinx.parsers.Parser.app

  • sphinx.testing.path.Path.text()

  • sphinx.testing.path.Path.bytes()

  • sphinx.util.inspect.getargspec()

  • sphinx.writers.latex.LaTeXWriter.format_docclass()

Hinzugefügte Funktionen

3.0.0b1

  • #247: autosummary: Hinzufügen von autosummary_generate_overwrite, um alte Stub-Dateien zu überschreiben

  • #5923: autodoc: Die Option :inherited-members: nimmt den Namen einer Oberklasse an, von der keine geerbten Member dokumentiert werden sollen, und deren Oberen

  • #6830: autodoc: Ein Member wird als privat betrachtet, wenn der Docstring :meta private: in der Info-Field-List enthält

  • #7165: autodoc: Unterstützung für annotierte Typen (PEP-593)

  • #2815: autodoc: Unterstützung für singledispatch-Funktionen und -Methoden

  • #7079: autodoc: autodoc_typehints akzeptiert die Konfiguration "description". Sie zeigt Typenhinweise als Objektbeschreibung an

  • #7314: apidoc: Weitergabe der Option --maxdepth über Paketdokumente hinweg

  • #6558: Glossar: Warnung für doppelte Glossareinträge ausgeben

  • #3106: Domäne: Hyperlink-Ziel für Indexseite automatisch registrieren

  • #6558: std-Domäne: Warnung für doppelte generische Objekte ausgeben

  • #6830: py-Domäne: Neues Ereignis: object-description-transform

  • #6895: py-Domäne: Keine sehr genauen Warnungen für eingebaute Typen ausgeben

  • py-Domäne: Unterstützung für Lambda-Funktionen in Funktionssignaturen

  • #6417: py-Domäne: Ermöglicht das Erstellen eines Stils für Argumente von Funktionen und Methoden

  • #7238, #7239: py-Domäne: Warnung ausgeben, wenn ein Python-Objekt beschrieben wird und der Eintrag bereits unter demselben Namen vorhanden ist

  • #7341: py-Domäne: Typannotationen in Signaturen werden in Querverweise umgewandelt

  • Unterstützung der Priorität von Ereignisbehandlern. Weitere Details siehe Sphinx.connect()

  • #3077: Implementierung des Scoping für productionlist, wie in der Dokumentation angegeben.

  • #1027: Unterstützung für Backslash-Zeilenfortsetzung in productionlist.

  • #7108: Konfiguration: Ermöglicht das Anzeigen einer Fehlermeldung von conf.py über ConfigError

  • #7032: html: html_scaled_image_link wird für Bilder mit der Klasse no-scaled-link deaktiviert

  • #7144: CSS-Klasse hinzufügen, die die Domäne für jeden desc-Knoten angibt

  • #7211: latex: babel für chinesische Dokumente verwenden, wenn XeLaTeX verwendet wird

  • #6672: LaTeX: Unterstützung für LaTeX-Theming (experimentell)

  • #7005: LaTeX: LaTeX-Stilmakro für die kbd-Rolle hinzufügen

  • #7220: genindex: „Haupt“-Indexeinträge zuerst anzeigen

  • #7103: linkcheck: schreibt alle Links nach output.json

  • #7025: html-Suche: Volltextsuche kann für einzelne Dokumente über die dateiweite Metadaten :nosearch: deaktiviert werden

  • #7293: html-Suche: Ermöglicht das Überschreiben des JavaScript-Splitters über SearchLanguage.js_splitter_code

  • #7142: html-Theme: Eine Theme-Option hinzufügen: pygments_dark_style zum Umschalten des Stils von Codeblöcken im Dark Mode

  • Die C-Domäne wurde neu geschrieben, einschließlich

    • Querverweise, die den aktuellen Gültigkeitsbereich respektieren.

    • Dokumentation anonymer Entitäten möglich.

    • Spezifischere Direktiven und Rollen für jeden Entitätstyp, z. B. Behandlung des Scoping von Enumeratoren.

    • Neue Rolle c:expr zum Rendern von Ausdrücken und Typen im Text.

  • Hinzugefügt SphinxDirective.get_source_info() und SphinxRole.get_source_info().

  • #7324: sphinx-build: Warnung ausgeben, wenn mehrere Dateien mit unterschiedlichen Dateierweiterungen für dasselbe Dokument gefunden werden

3.0.0 final

  • Hinzugefügt ObjectDescription.transform_content().

Behobene Fehler

3.0.0b1

  • C++, Korrektur der Querverweis-Suche in bestimmten Fällen, die Funktionsüberladungen betreffen.

  • #5078: C++, Korrektur der Querverweis-Suche, wenn eine Direktive mehrere Deklarationen enthält.

  • C++, Warnungen für direkt abhängige Typnamen in Querverweisen, die automatisch in Signaturen generiert werden, unterdrücken.

  • #5637: autodoc: Falsche Behandlung von verschachtelten Klassennamen bei show-inheritance

  • #7267: autodoc: Fehlermeldung für ungültige Direktivenoptionen hat falsche Position

  • #7329: autodoc: Info-Field-List wird fälschlicherweise aus Typenhints in die Klassendeskription generiert, auch wenn autoclass_content='class' gesetzt ist

  • #7331: autodoc: Eine Cython-Funktion wird nicht als Funktion erkannt

  • #5637: inheritance_diagram: Falsche Behandlung von verschachtelten Klassennamen

  • #7139: code-block:: guess funktioniert nicht

  • #7325: html: source_suffix mit Punkt führt zu falschem Quellcode-Link

  • #7357: html: Skalierung von SVG-Bildern schlägt mit ValueError fehl

  • #7278: html-Suche: Verwendung von html_file_suffix anstelle von html_link_suffix in Suchergebnissen korrigiert

  • #7297: html-Theme: bizstyle unterstützt sidebarwidth nicht

  • #3842: singlehtml: Pfad zu Bildern unterbrochen, wenn die Master-Dokumentation nicht im Quellcode-Stammverzeichnis liegt

  • #7179: std-Domäne: Leerzeichen werden bei der Bezugnahme auf GenericObject unterdrückt

  • #7289: Konsole: Helle Farben anstelle von Fett verwenden

  • #1539: C, Parsen von Array-Typen.

  • #2377: C, Parsen von Funktionszeigern auch in komplexen Typen.

  • #7345: sphinx-build: Sphinx stürzt ab, wenn das Ausgabeverzeichnis als Datei existiert

  • #7290: sphinx-build: bdb.BdbQuit beim Behandeln von Ausnahmen ignorieren

  • #6240: napoleon: Attribute und Methoden-Abschnitte ignorieren die :noindex:-Option

3.0.0 final

  • #7364: autosummary: Absturz, wenn autosummary_generate auf False gesetzt ist

  • #7370: autosummary: Löst UnboundLocalError aus, wenn ein unbekanntes Modul angegeben wird

  • #7367: C++, alternative Operator-Schreibweisen werden jetzt unterstützt.

  • C, alternative Operator-Schreibweisen werden jetzt unterstützt.

  • #7368: C++, Komma-Operator in Ausdrücken, Pack-Expansion in Vorlagen-Argumentlisten und umfassendere Fehlermeldungen in einigen Fällen.

  • C, C++, Absturz und falsche doppelte Warnungen im Zusammenhang mit anonymen Symbolen behoben.

  • #6477: Maskierung des ersten „!“ in einem Querverweis, der keine Verknüpfung mehr ermöglicht

  • #7219: py-Domäne: Der von der py:function-Direktive generierte Indexeintrag unterscheidet sich von dem der index-Direktive mit dem Typ „builtin“

  • #7301: Großbuchstaben sind für node_id nicht zulässig

  • #7301: epub: Doppelte node_ids werden generiert

  • #6564: html: Die Breite von Tabellen wurde im HTML-Builder ignoriert

  • #7401: Falsches Argument wird an env-get-outdated-Handler übergeben

  • #7355: autodoc: Die Signatur einer Cython-Funktion wird nicht richtig erkannt

  • #7222: autodoc: __wrapped__-Funktionen werden nicht korrekt dokumentiert

  • #7409: intersphinx: ValueError wird ausgelöst, wenn eine Erweiterung intersphinx_mapping beim Ereignis config-inited konfiguriert

  • #7343: Sphinx-Builds sind seit 2.4.0 im Debug-Modus langsamer geworden