Sphinx 6.2

Release 6.2.1 (veröffentlicht 25. April 2023)

Behobene Fehler

Release 6.2.0 (veröffentlicht 23. April 2023)

Abhängigkeiten

  • Docutils 0.18.1 oder höher erforderlich.

Inkompatible Änderungen

  • LaTeX: Entfernung einiger interner TeX \dimen Register (nicht öffentlich dokumentiert) gemäß 5.1.0 Code-Kommentaren in sphinx.sty: \sphinxverbatimsep, \sphinxverbatimborder, \sphinxshadowsep, \sphinxshadowsize und \sphinxshadowrule. (refs: #11105)

  • Entferne .egg-Unterstützung von pycode ModuleAnalyser; Python Eggs sind ein jetzt veraltetes binäres Distributionsformat

  • #11089: Entferne veralteten Code in sphinx.builders.linkcheck. Patch von Daniel Eades

  • Entferne nur intern verwendete sphinx.locale.setlocale

Veraltet

  • #11247: Depreziere das Legacy-Format für intersphinx_mapping

  • sphinx.util.osutil.cd wird zugunsten von contextlib.chdir depreziert.

Hinzugefügte Funktionen

  • #11277: autoproperty erlaubt die Angabe des Rückgabetyps als Typkommentar (z. B. # type: () -> int). Patch von Bénédikt Tran

  • #10811: Autosummary: Erweitere __all__ auf importierte Member für die Template-Renderung, wenn die Option autosummary_ignore_module_all auf False gesetzt ist. Patch von Clement Pinard

  • #11147: Füge einen Parameter content_offset zu nested_parse_with_titles() hinzu, der korrekte Zeilennummern während des verschachtelten Parsens ermöglicht. Patch von Jeremy Maitin-Shepard

  • Update auf Unicode CLDR 42

  • Füge ein --jobs-Synonym für -j hinzu. Patch von Hugo van Kemenade

  • LaTeX: ein Befehl \sphinxbox zum Stylen von Textelementen mit einer (möglicherweise abgerundeten) Box, optionaler Hintergrundfarbe und Schatten, wurde hinzugefügt. Siehe Der Befehl \sphinxbox. (refs: #11224)

  • LaTeX: Füge \sphinxstylenotetitle, …, \sphinxstylewarningtitle, …, für eine zusätzliche Ebene der Auszeichnung hinzu, wodurch \sphinxstrong für andere Verwendungen freigegeben wird. Siehe Makros. (refs: #11267)

  • LaTeX: Note, Hint, Important und Tip können nun jeweils wie die anderen Admonitions gestylt werden, d. h. möglicherweise mit Hintergrundfarbe, individuellen Randstärken und Abständen, abgerundeten Ecken und optionalem Schatten. Siehe Zusätzliche CSS-ähnliche 'sphinxsetup'-Schlüssel. (refs: #11234)

  • LaTeX: Admonitions und Topic (und TOC) Direktiven, und nicht nur code-block, unterstützen box-decoration-break=slice.

  • LaTeX: runde Boxen unterstützen bis zu 4 verschiedene Randstärken (refs: #11243)

  • LaTeX: neue Optionen noteTextColor, noteTeXextras usw. Siehe Zusätzliche CSS-ähnliche 'sphinxsetup'-Schlüssel.

  • LaTeX: Unterstützung für elliptische Ecken in runden Boxen. (refs: #11254)

  • #11150: Quellort in Hervorhebungen von Warnungen einfügen, wenn die Lexikalisierung fehlschlägt. Patch von Jeremy Maitin-Shepard

  • #11281: Unterstützung für imgmath_latex = 'tectonic' oder = 'xelatex'. Patch von Dimitar Dimitrov

  • #11109, #9643: Füge die Option python_display_short_literal_types für die kondensierte Darstellung von Literal-Typen hinzu.

Behobene Fehler

  • #11079: LaTeX: Abbildungen mit dem Attribut `align` können verschwinden und nachfolgende Listen seltsam beeinflussen

  • #11093: LaTeX: "Mehrfach definierte Referenzen"-PDF-Build-Warnungen beheben, wenn eine oder mehrere reST-Labels direkt vor einer py:module oder automodule-Direktive stehen. Patch von Bénédikt Tran (picnixz)

  • #11110: LaTeX: Abbildungen fehlen im PDF, wenn ihre Dateien denselben Basisnamen haben und eine Nachbearbeitung verwendet wird. Patch von aaron-cooper

  • LaTeX: Behebe potenziellen Farbleck von Schatten zu Rand von abgerundeten Boxen, wenn Schattenfarbe gesetzt ist, aber Randfarbe nicht

  • LaTeX: Behebe unbeabsichtigte 1pt aufwärts vertikale Verschiebung von Code-Block-Rahmen relativ zum Inhalt (bei Verwendung abgerundeter Ecken)

  • #11235: LaTeX: \color in Topic- (oder Admonition-) Inhalten kann zu Farbleck zum Schatten und Rand bei einem Seitenumbruch führen

  • #11264: LaTeX: Fehlender Leerschlag vor Doppelpunkt nach „Voir aussi“ für die seealso-Direktive im Französischen

  • #11268: LaTeX: Longtable mit linksbündiger Ausrichtung bricht aus dem aktuellen Listen-Einrückungskontext im PDF aus. Dank an picnixz.

  • #11274: LaTeX: Externe Links werden nicht ordnungsgemäß für die Kompatibilität mit \sphinxupquote escapet

  • #11147: Korrigiere Quellcode-/Zeilennummerinformationen im Objektbeschreibungsinhalt und in anderen Verwendungen von nested_parse_with_titles. Patch von Jeremy Maitin-Shepard.

  • #11192: Stelle die korrekte parallele Erstellung des Suchindexes wieder her. Patch von Jeremy Maitin-Shepard

  • Verwende den neuen Transifex tx-Client

Tests

  • Fehlertests, wenn Python-Warnungen ausgegeben werden

  • Migriere verbleibende Testfunktionen im Stil von unittest.TestCase zu pytest-Stil

  • Entferne Tests, die auf Setuptools angewiesen sind