Sphinx 2.2

Release 2.2.2 (veröffentlicht am 03. Dez. 2019)

Inkompatible Änderungen

  • #6803: Aus Sicherheitsgründen von Python ist der Parallelmodus unter macOS und Python 3.8+ deaktiviert.

Behobene Fehler

  • #6776: LaTeX: LaTeX-Release vom 01.10.2019 bricht sphinxcyrillic.sty

  • #6815: i18n: Französische, Hindi-, chinesische, japanische und koreanische Übersetzungen sind fehlerhaft.

  • #6803: Paralleler Build verursacht AttributeError unter macOS und Python 3.8.

Release 2.2.1 (veröffentlicht am 26. Okt. 2019)

Behobene Fehler

  • #6641: LaTeX: Undefinierte Steuersequenz \sphinxmaketitle

  • #6710: LaTeX ist für Griechisch als Hauptsprache nicht gut konfiguriert.

  • #6759: Die Validierung von statischen HTML-Pfaden und zusätzlichen Pfaden wirft keinen Fehler mehr, wenn die Pfade in verschiedenen Verzeichnissen liegen.

Release 2.2.0 (veröffentlicht am 19. Aug. 2019)

Inkompatible Änderungen

  • apidoc: Vorlagendateien werden in .rst_t umbenannt.

  • html: Feldlisten werden mit Gitterlayout gestaltet.

Veraltet

  • sphinx.domains.math.MathDomain.add_equation()

  • sphinx.domains.math.MathDomain.get_next_equation_number()

  • Die Argumente info und warn von sphinx.ext.autosummary.generate.generate_autosummary_docs()

  • sphinx.ext.autosummary.generate._simple_info()

  • sphinx.ext.autosummary.generate._simple_warn()

  • sphinx.ext.todo.merge_info()

  • sphinx.ext.todo.process_todo_nodes()

  • sphinx.ext.todo.process_todos()

  • sphinx.ext.todo.purge_todos()

Hinzugefügte Funktionen

  • #5124: graphviz: Option :graphviz_dot: wird in :layout: umbenannt.

  • #1464: html: Warnung ausgeben, wenn html_static_path und html_extra_path Verzeichnisse sich im Ausgabeverzeichnis befinden.

  • #6514: html: Label für die Suchleiste zur Verbesserung der Barrierefreiheit hinzugefügt.

  • #5602: apidoc: Option --templatedir hinzugefügt.

  • #6475: Argument override zu app.add_autodocumenter() hinzugefügt.

  • #6310: imgmath: imgmath_use_preview funktioniert auch mit dem SVG-Format für Inline-Mathematikbilder.

  • #6533: LaTeX: visit_enumerated_list() refaktoriert zur Verwendung von \sphinxsetlistlabels.

  • #6628: quickstart: Verwendet https://docs.pythonlang.de/3/ als Standardeinstellung für intersphinx_mapping.

  • #6419: sphinx-build: Gründe für den Neuerstellungsprozess angegeben.

Behobene Fehler

  • py-Domäne: Doppelte Warnung zeigt nicht den Quellcode-Ort an.

  • #6499: html: Sphinx aktualisiert eine Kopie von html_logo nicht, selbst wenn sich die Originaldatei geändert hat.

  • #1125: html-Theme: Scrollbalken ist im Classic-Theme und unter macOS schwer zu sehen.

  • #5502: linkcheck: HTTP-503-Antworten nicht als Fehler betrachten.

  • #6439: Generierte Download-Links reproduzierbar machen.

  • #6486: UnboundLocalError wird ausgelöst, wenn eine fehlerhafte Erweiterung installiert ist.

  • #6567: autodoc: autodoc_inherit_docstrings hat keine Auswirkung auf __init__() und __new__().

  • #6574: autodoc: autodoc_member_order berücksichtigt nicht die Reihenfolge der Importe, wenn die Reihenfolge 'bysource' ist.

  • #6574: autodoc: Fehlende Typannotationen für variadische und Keyword-Parameter.

  • #6589: autodoc: Formatierungsprobleme mit autodoc_typehints='none'.

  • #6605: autodoc: Absturz, wenn der Zielcode benutzerdefinierte methodenähnliche Objekte enthält.

  • #6498: autosummary: Absturz bei falscher autosummary_generate-Einstellung.

  • #6507: autosummary: Absturz ohne autosummary_generate-Einstellung.

  • #6511: LaTeX: Automatisch nummerierte Listen können in LaTeX seit Sphinx 1.8.0 nicht mehr angepasst werden (siehe: #6533).

  • #6531: Fehler beim Laden des letzten Umweltdatenobjekts nach Hinzufügen einer Erweiterung.

  • #736: Falsche Sortierung im Paar-Index.

  • #6527: last_updated geht fälschlicherweise von UTC als Zeitzone aus.

  • #5592: std-Domäne: Die Direktive option registriert einen Indexeintrag für jede durch Kommas getrennte Option.

  • #6549: sphinx-build: Maskierte Zeichen in Fehlermeldungen.

  • #6545: Doctest-Kommentare werden seit Sphinx 1.8.0 nicht mehr gekürzt.

  • #6561: Glossar: Falsche Hyperlinks werden für nicht-alphanumerische Begriffe generiert.

  • #6620: i18n: Klassifikatoren der Definitionsliste werden mit Docutils 0.15 nicht übersetzt.

  • #6474: DocFieldTransformer löst AttributeError aus, wenn die angegebene Direktive keine Unterklasse von ObjectDescription ist.