Sphinx 3.3

Release 3.3.1 (veröffentlicht am 12. Nov. 2020)

Behobene Fehler

  • #8372: autodoc: Autoclass-Direktive wurde langsamer als Sphinx 3.2

  • #7727: autosummary: Löst PycodeError aus, wenn ein Python-Paket ohne __init__.py dokumentiert wird

  • #8350: autosummary: autosummary_mock_imports verlangsamt Builds

  • #8364: C: Attribute in leeren Symbolen korrekt initialisieren.

  • #8399: i18n: System-Locale-Pfad nach den in der Konfiguration angegebenen Pfaden platzieren

Release 3.3.0 (veröffentlicht am 02. Nov. 2020)

Veraltet

  • sphinx.builders.latex.LaTeXBuilder.usepackages

  • sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref

  • sphinx.ext.autodoc.SingledispatchFunctionDocumenter

  • sphinx.ext.autodoc.SingledispatchMethodDocumenter

Hinzugefügte Funktionen

  • #8100: html: Bessere Fehlermeldung für Fehler beim Kopieren von html_static_files anzeigen

  • #8141: C: Option maxdepth zu c:alias hinzugefügt, um verschachtelte Deklarationen einzufügen.

  • #8081: LaTeX: LaTeX-Paket über app.add_latex_package() bis kurz vor dem Schreiben der .tex-Datei hinzufügen

  • #7996: Manpage: man_make_section_directory hinzugefügt, um ein Abschnittsverzeichnis beim Erstellen von Manpages zu erstellen

  • #8289: epub: Möglichkeit, Warnungen "duplicated ToC entry found" vom epub-Builder mit suppress_warnings zu unterdrücken.

  • #8298: sphinx-quickstart: Option sphinx-quickstart --no-sep hinzugefügt

  • #8304: sphinx.testing: Öffentliche Marker in sphinx.testing.fixtures registrieren

  • #8051: napoleon: obj-Rolle für alle See Also-Elemente verwenden

  • #8050: napoleon: napoleon_preprocess_types auf jedes Feld anwenden

  • C und C++: Zeilennummern für vorherige Deklarationen anzeigen, wenn Duplikate erkannt werden.

  • #8183: substitution_reference-Knoten nur bei LaTeX-Builds aus dem Doctree entfernen

Behobene Fehler

  • #8085: i18n: Unterstützung für eine einzige Textdomäne hinzufügen

  • #6640: i18n: Systemnachricht-Übersetzung konnte nicht überschrieben werden

  • #8143: autodoc: AttributeError wird ausgelöst, wenn False an autodoc_default_options übergeben wird

  • #8103: autodoc: functools.cached_property wird nicht als Eigenschaft erkannt

  • #8190: autodoc: Parsing-Fehler wird ausgelöst, wenn eine Erweiterung die Docstring durch einen String ersetzt, der nicht mit Leerzeilen endet

  • #8142: autodoc: Falsche Konstruktorsignatur für die von typing.Generic abgeleitete Klasse

  • #8157: autodoc: TypeError wird ausgelöst, wenn die Annotation ungültige __args__ hat

  • #7964: autodoc: Tupel im Standardwert wird falsch gerendert

  • #8200: autodoc: Typ-Aliase brechen die Typformatierung von autoattribute

  • #7786: autodoc: überladene Methoden, die in einer anderen Datei definiert sind, können nicht erkannt werden

  • #8294: autodoc: Single-String __slots__ wird nicht korrekt behandelt

  • #7785: autodoc: autodoc_typehints='none' hat keine Auswirkung auf überladene Funktionen

  • #8192: napoleon: Beschreibung verschwindet, wenn sie Inline-Literale enthält

  • #8142: napoleon: Potenzial für Regex-Denial-of-Service in Google-Style-Dokumenten

  • #8169: LaTeX: pxjahyper wird geladen, auch wenn latex_engine nicht platex ist

  • #8215: LaTeX: 'oneside' classoption verursacht Build-Warnung

  • #8175: intersphinx: Potenzial für Regex-Denial-of-Service durch fehlerhaftes Inventar

  • #8277: sphinx-build: Fehlende und redundante Leerzeichen (und etc.) für Konsolenausgabe beim Bauen

  • #7973: imgconverter: Verfügbarkeit von ImageMagick mehrmals prüfen

  • #8255: py-Domäne: Nummer im Standardargumentwert wird von hexadezimal zu dezimal geändert

  • #8316: html: Verhindern, dass Pfeiltasten die Seite wechseln, wenn Button-Elemente fokussiert sind

  • #8343: html-Suche: Behebung der unnötigen Bildladung beim Parsen des Dokuments

  • #8254: html-Theme: Zeilennummern passen nicht zu Codezeilen

  • #8093: Die Highlight-Warnung hat bei einigen Buildern (LaTeX, singlehtml usw.) den falschen Speicherort

  • #8215: Fancyhdr-Build-Warnungen für One-Side-Dokumente eliminieren

  • #8239: Referenz auf ein Token in productionlist fehlgeschlagen, wenn es eingerückt ist

  • #8268: linkcheck: HTTP-Fehler melden, wenn linkcheck_anchors True ist

  • #8245: linkcheck: Berücksichtigen des Quellverzeichnisses für lokale Dateien

  • #8321: linkcheck: tel: Schema-Hyperlinks werden als Fehler erkannt

  • #8323: linkcheck: Exit-Status ist falsch, wenn Links mit nicht unterstütztem Schema gefunden werden

  • #8188: C: Fehlende Elemente zum internen Wörterbuch für Objekttypen hinzufügen, z. B. um zu verhindern, dass Intersphinx sie auflöst.

  • C: Anonyme Objekte in Intersphinx korrigieren.

  • #8270: C++: Funktionen korrekt als doppelte Deklarationen ablehnen, wenn bereits eine Nicht-Funktions-Deklaration mit demselben Namen vorhanden ist.

  • C: Verweise auf Funktionsparameter korrigieren. Zum Link zur Funktion statt zu einem nicht existierenden Anker.

  • #6914: Abbildungsnummern werden unerwartet unbeschrifteten Elementen zugewiesen

  • #8320: Inline-Zeilennummern nicht auswählbar machen

Tests

  • #8257: Parallele Builds in sphinx.testing unterstützen