sphinx-6.2.0 (Python module)

[Bruce Dubbs]

New minor version.

[Bruce Dubbs]

Release 6.2.0 (released Apr 23, 2023)

Dependencies

• Require Docutils 0.18.1 or greater.

Incompatible changes

• LaTeX: removal of some internal TeX \dimen registers (not previously publicly documented) as per 5.1.0 code comments in sphinx.sty: \sphinxverbatimsep, \sphinxverbatimborder, \sphinxshadowsep, \sphinxshadowsize, and \sphinxshadowrule.
• Remove .egg support from pycode ModuleAnalyser; Python eggs are a now-obsolete binary distribution format
• Remove deprecated code in sphinx.builders.linkcheck.
• Remove internal-only sphinx.locale.setlocale

Deprecated

• Deprecate the legacy intersphinx_mapping format
• sphinx.util.osutil.cd is deprecated in favour of contextlib.chdir.

Features added

• :rst:dir:`autoproperty` allows the return type to be specified as a type comment (e.g., # type: () -> int).
• Autosummary: extend all to imported members for template rendering when option autosummary_ignore_module_all is set to False.
• Add a content_offset parameter to nested_parse_with_titles(), allowing for correct line numbers during nested parsing.
• Update to Unicode CLDR 42
• Add a --jobs synonym for -j.
• LaTeX: a command \sphinxbox for styling text elements with a (possibly rounded) box, optional background color and shadow, has been added. See :ref:sphinxbox.
• LaTeX: add \sphinxstylenotetitle, ..., \sphinxstylewarningtitle, ..., for an extra layer of mark-up freeing up \sphinxstrong for other uses. See :ref:latex-macros.
• LaTeX: :dudir:note, :dudir:hint, :dudir:important and :dudir:tip can now each be styled as the other admonitions, i.e. possibly with a background color, individual border widths and paddings, possibly rounded corners, and optional shadow. See :ref:additionalcss.
• LaTeX: admonitions and :dudir:topic (and :dudir:contents <table-of-contents>) directives, and not only :rst:dir:`code-block, support box-decoration-break=slice`.
• LaTeX: let rounded boxes support up to 4 distinct border-widths
• LaTeX: new options noteTextColor, noteTeXextras et al. See :ref:additionalcss.
• LaTeX: support elliptical corners in rounded boxes.
• Include source location in highlighting warnings, when lexing fails.
• Support for :confval:imgmath_latex = 'tectonic' or = 'xelatex'.
• Add :confval:python_display_short_literal_types option for condensed rendering of Literal types.

Bugs fixed

• LaTeX: figures with align attribute may disappear and strangely impact following lists
• LaTeX: fix "multiply-defined references" PDF build warnings when one or more reST labels directly precede an :rst:dir:`py:module or :rst:dir:automodule` directive.
• LaTeX: Figures go missing from latex pdf if their files have the same base name and they use a post transform.
• LaTeX: fix potential color leak from shadow to border of rounded boxes, if shadow color is set but border color is not
• LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames respective to contents (when using rounded corners)
• LaTeX: added \color in topic (or admonition) contents may cause color leak to the shadow and border at a page break
• LaTeX: missing space before colon after "Voir aussi" for :rst:dir:`seealso` directive in French
• LaTeX: longtable with left alignment breaks out of current list indentation context in PDF.
• LaTeX: external links are not properly escaped for \sphinxupquote compatibility
• Fix source file/line number info in object description content and in other uses of nested_parse_with_titles.
• Restore correct parallel search index building.
• Use the new Transifex tx client

Testing

• Fail testing when any Python warnings are emitted
• Migrate remaining unittest.TestCase style test functions to pytest style
• Remove tests that rely on setuptools

[Bruce Dubbs]

Fixed at commit 1d6fda16826534bb07a6f462df1355e0576a4c03

[Bruce Dubbs]

Milestone renamed