Sphinx 3.1

Release 3.1.2 (veröffentlicht am 05. Jul 2020)

Inkompatible Änderungen

  • #7650: autodoc: Die Signatur der Basis Funktion wird für dekorierte Funktionen angezeigt, nicht die Signatur des Dekorators

Behobene Fehler

  • #7844: autodoc: Modul kann nicht erkannt werden, wenn relativer Modulname angegeben wurde

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

  • #7850: autodoc: KeyError wird für ungültiges Markup ausgelöst, wenn autodoc_typehints auf „description“ gesetzt ist

  • #7812: autodoc: Absturz, wenn der Zielname sowohl mit einem Attribut als auch mit einem Modul übereinstimmt, die denselben Namen haben

  • #7650: autodoc: Die Funktionssignatur wird (*args, **kwargs), wenn die Funktion durch einen generischen Dekorator dekoriert ist

  • #7812: autosummary: Generiert kaputte Stub-Dateien, wenn der Zielcode ein Attribut und ein Modul mit demselben Namen enthält

  • #7806: viewcode: Referenzen auf viewcode können bei 3rd-Party-Buildern nicht aufgelöst werden

  • #7838: html-Theme: Listenelemente haben zusätzlichen vertikalen Abstand

  • #7878: html-Theme: Unerwünschte Interaktion zwischen „overflow“ und „float“

Release 3.1.1 (veröffentlicht am 14. Jun 2020)

Inkompatible Änderungen

  • #7808: napoleon: Ein Typ für ein Attribut wird als typisiertes Feld dargestellt

Hinzugefügte Funktionen

  • #7807: autodoc: Detaillierte Warnung anzeigen, wenn type_comment nicht mit der Signatur übereinstimmt

Behobene Fehler

  • #7808: autodoc: Warnungen bei Typannotationen für Variablen und Attribute

  • #7802: autodoc: EOFError wird bei parallelem Build ausgelöst

  • #7821: autodoc: TypeError wird für überladene C-Erweiterungsfunktion ausgelöst

  • #7805: autodoc: Ein Objekt, das von Deskriptoren zurückgegeben wird, wird unerwartet dokumentiert

  • #7807: autodoc: Falsche Signatur wird für Funktionen mit contextmanager angezeigt

  • #7812: autosummary: Generiert kaputte Stub-Dateien, wenn der Zielcode ein Attribut und ein Modul mit demselben Namen enthält

  • #7808: napoleon: Warnungen bei Typannotationen für Variablen und Attribute

  • #7811: sphinx.util.inspect verursacht zirkuläre Importprobleme

Release 3.1.0 (veröffentlicht am 08. Jun 2020)

Abhängigkeiten

  • #7746: mathjax: Update auf 2.7.5

Inkompatible Änderungen

  • #7477: imgconverter: Führt standardmäßig den Befehl „magick convert“ unter Windows aus

Veraltet

  • Das erste Argument für sphinx.ext.autosummary.generate.AutosummaryRenderer wurde zu einem Sphinx-Objekt geändert

  • sphinx.ext.autosummary.generate.AutosummaryRenderer nimmt einen Objekttyp als Argument

  • Das ignore-Argument von sphinx.ext.autodoc.Documenter.get_doc()

  • Das template_dir-Argument von sphinx.ext.autosummary.generate. AutosummaryRenderer

  • Das module-Argument von sphinx.ext.autosummary.generate. find_autosummary_in_docstring()

  • Das builder-Argument von sphinx.ext.autosummary.generate. generate_autosummary_docs()

  • Das template_dir-Argument von sphinx.ext.autosummary.generate. generate_autosummary_docs()

  • Das ignore-Argument von sphinx.util.docstring.prepare_docstring()

  • sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()

  • sphinx.util.rpartition()

Hinzugefügte Funktionen

  • LaTeX: Die Einstellung toplevel_sectioning im LaTeX-Theme optional machen

  • LaTeX: Ermöglicht das Überschreiben von papersize und pointsize aus LaTeX-Themes

  • LaTeX: Hinzufügen von latex_theme_options zum Überschreiben von Theme-Optionen

  • #7410: Ermöglicht das Unterdrücken von Warnungen „zirkuläre toctree-Referenzen erkannt“ mithilfe von suppress_warnings

  • C, hinzugefügte Scope-Steuerungsdirektiven, c:namespace, c:namespace-push und c:namespace-pop.

  • #2044: autodoc: Unterdrückt Standardwerte für Instanzattribute

  • #7473: autodoc: Berücksichtigt ein Mitglied als öffentlich, wenn die Docstring :meta public: in der Info-Feld-Liste enthält

  • #7487: autodoc: Ermöglicht das Generieren von Dokumenten für singledispatch-Funktionen mit py:autofunction

  • #7143: autodoc: Unterstützt finale Klassen und Methoden

  • #7384: autodoc: Unterstützt Signaturen, die von __new__(), Metaklassen und eingebauten Basisklassen definiert wurden

  • #2106: autodoc: Unterstützt mehrere Signaturen in der Docstring

  • #4422: autodoc: Unterstützt GenericAlias in Python 3.7 oder höher

  • #3610: autodoc: Unterstützt überladene Funktionen

  • #7722: autodoc: Unterstützt TypeVar

  • #7466: autosummary: Überschriften in generierten Dokumenten werden nicht übersetzt

  • #7490: autosummary: Fügt die Option :caption: zur autosummary-Direktive hinzu, um eine Beschriftung für die toctree festzulegen

  • #7469: autosummary: Unterstützt Modulattribute

  • #248, #6040: autosummary: Fügt die Option :recursive: zur autosummary-Direktive hinzu, um Stub-Dateien rekursiv zu generieren

  • #4030: autosummary: Fügt autosummary_context hinzu, um Template-Variablen für benutzerdefinierte Templates hinzuzufügen

  • #7530: html: Unterstützt verschachtelte <kbd>-Elemente

  • #7481: html-Theme: Fügt einen rechten Rand für Fußnoten-/Zitierungsbeschriftungen hinzu

  • #7482, #7717: html-Theme: CSS-Abstände für Codeblöcke mit Beschriftungen und Zeilennummern

  • #7443: html-Theme: Fügt neue Optionen globaltoc_collapse und globaltoc_includehidden hinzu, um das Verhalten von globaltoc in der Seitenleiste zu steuern

  • #7484: html-Theme: Vermeidet Konflikte zwischen der Seitenleiste und anderen Blöcken

  • #7476: html-Theme: Die Relbar-Breadcrumb sollte die aktuelle Seite enthalten

  • #7506: html-Theme: Eine kanonische URL wird nicht escaped

  • #7533: html-Theme: Vermeidet Leerzeichen am Anfang von genindex.html

  • #7541: html-Theme: Fügt einen „clearer“ am Ende des „body“ hinzu

  • #7542: html-Theme: Macht Admonition/Topic/Sidebar scrollbar

  • #7543: html-Theme: Fügt obere und untere Ränder zu Tabellen hinzu

  • #7695: html-Theme: Fügt das viewport-Meta-Tag für das Basis-Theme hinzu

  • #7721: html-Theme: classic: codetextcolor/codebgcolor überschreiben Pygments nicht standardmäßig

  • C und C++: erlaubt Semikolon am Ende von Deklarationen.

  • C++, parst parametrisierte noexcept-Spezifizierer.

  • #7294: C++, parst Ausdrücke mit benutzerdefinierten Literalen.

  • C++, parst nachfolgende Rückgabetypen.

  • #7143: py-Domäne: Fügt die Option :final: zu den Direktiven py:class, py:exception und py:method hinzu

  • #7596: py-Domäne: Ändert eine Typannotation für Variablen in einen Hyperlink

  • #7770: std-Domäne: Die option-Direktive unterstützt Argumente in der Form foo[=bar]

  • #7582: napoleon: Ein Typ für ein Attribut wird wie eine Typannotation dargestellt

  • #7734: napoleon: Übermäßiges Escaping des nachfolgenden Unterstrichs bei Attributen

  • #7247: linkcheck: Fügt linkcheck_request_headers hinzu, um benutzerdefinierte HTTP-Header für bestimmte Hosts zu senden

  • #7791: setuptools: Unterstützt die Option --verbosity

  • #7683: Fügt den Parameter allowed_exceptions zu Sphinx.emit() hinzu, um Handlern das Auslösen bestimmter Ausnahmen zu ermöglichen

  • #7295: C++, parst (nachfolgende) requires-Klauseln.

Behobene Fehler

  • #6703: autodoc: inkrementelles Builden funktioniert nicht für importierte Objekte

  • #7564: autodoc: Annotationen werden nicht für Deskriptoren angezeigt

  • #6588: autodoc: Dekorierte geerbte Methode hat keine Dokumentation

  • #7469: autodoc: Die Änderung von autodoc-process-docstring für Variablen wird unerwartet zwischengespeichert

  • #7559: autodoc: Falsche Erkennung einer synchronen Funktion als asynchron

  • #6857: autodoc: Kann classmethod auf Enum-Klasse nicht erkennen

  • #7562: autodoc: Ein Typ-Hint, der Leerzeichen enthält, wird unter autodoc_typehints='description'-Modus falsch gerendert

  • #7551: autodoc: Kann verschachtelte Klasse nicht importieren

  • #7362: autodoc: Rendert keine korrekten Signaturen für eingebaute Funktionen

  • #7654: autodoc: Optional[Union[foo, bar]] wird als Union[foo, bar, None] dargestellt

  • #7629: autodoc: autofunction gibt eine unfreundliche Warnung aus, wenn ein ungültiges Objekt angegeben wird

  • #7650: autodoc: Undekorierte Signatur wird für dekorierte Funktionen angezeigt

  • #7676: autodoc: Tippfehler im Standardwert von autodoc_member_order

  • #7676: autodoc: Falscher Wert für die Option :member-order: wird stillschweigend ignoriert

  • #7676: autodoc: member-order=”bysource” funktioniert nicht für C-Module

  • #3673: autodoc: member-order=”bysource” funktioniert nicht für ein Modul mit __all__

  • #7668: autodoc: Falscher retann-Wert wird an einen Handler von autodoc-process-signature übergeben

  • #7711: autodoc: Scheitert mit ValueError beim Verarbeiten von NumPy-Objekten

  • #7791: autodoc: TypeError wird beim Dokumentieren einer singledispatch-Funktion ausgelöst

  • #7551: autosummary: Eine verschachtelte Klasse wird als nicht verschachtelte Klasse indiziert

  • #7661: autosummary: Die autosummary-Direktive gibt Warnungen zweimal aus, wenn das Zielmodul nicht importiert werden kann

  • #7685: autosummary: Die Template-Variable „members“ enthält importierte Mitglieder, auch wenn autossummary_imported_members False ist

  • #7671: autosummary: Der Speicherort der Importfehlermeldung fehlt

  • #7535: sphinx-autogen: Stürzt ab, wenn ein benutzerdefiniertes Template Vererbung verwendet

  • #7536: sphinx-autogen: Stürzt ab, wenn ein Template die i18n-Funktion verwendet

  • #7781: sphinx-build: Falsche Fehlermeldung, wenn outdir kein Verzeichnis ist

  • #7653: sphinx-quickstart: Korrigiert die Erstellung mehrerer Verzeichnisse für verschachtelte Relativpfade

  • #2785: html: Schlechte Ausrichtung von Gleichungslinks

  • #7718: html-Theme: Einige Themes respektieren die Hintergrundfarbe des Pygments-Stils nicht (agogo, haiku, nature, pyramid, scrolls, sphinxdoc und traditional)

  • #7544: html-Theme: Inkonsistente Abstände in Admonitions

  • #7581: napoleon: schlechtes Parsen von Inline-Code in Attribut-Docstrings

  • #7628: imgconverter: Führt imagemagick einmal unnötigerweise für Builder aus, die keine Bilder unterstützen

  • #7610: Rendert aufeinanderfolgende Backslashes für Docutils 0.16 falsch

  • #7646: Behandelt Fehler bei Event-Handlern

  • #4187: LaTeX: EN-Bindestrich verschwindet aus PDF-Lesezeichen in japanischen Dokumenten

  • #7701: LaTeX: Anonymer indirekter Hyperlink-Ziel verursacht doppelte Labels

  • #7723: LaTeX: pdflatex stürzt ab, wenn eine URL ein einzelnes Anführungszeichen enthält

  • #7756: py-Domäne: Der Standardwert für positionsgebundene Argumente wird nicht angezeigt

  • #7760: coverage: Fügt coverage_show_missing_items hinzu, um die Abdeckungsergebnisse in der Konsole anzuzeigen

  • C++, rendert und verweist verschachtelte Namen, die explizit im globalen Geltungsbereich beginnen, z. B. ::A::B, korrekt.

  • C, rendert und verweist verschachtelte Namen, die explizit im globalen Geltungsbereich beginnen, z. B. .A.B, korrekt.

  • #7763: C und C++, stürzt nicht ab bei der Anzeige von Stringifizierungen von unären Ausdrücken und Faltklauseln.