sphinx-7.4.4 (Python module)

[Bruce Dubbs]

New minor version.

[Bruce Dubbs]

Release 7.4.4 (released Jul 15, 2024)

Bugs fixed

• Do not warn when an intersphinx inventory contains case-insensitively ambiguous duplicate items.

Release 7.4.3 (released Jul 15, 2024)

Bugs fixed

• Restore support for list-styled :confval:source_suffix values with extensions that register parsers.

Release 7.4.2 (released Jul 15, 2024)

Bugs fixed

• Resolve failures with the C domain on incremental builds with Sphinx 7.3.7 and earlier.

Release 7.4.1 (released Jul 15, 2024)

Bugs fixed

• Fix invalid HTML when a rubric node with invalid heading-level is used.
• Restore support for typing.ParamSpec in autodoc.

Release 7.4.0 (released Jul 15, 2024)

Dependencies

• Drop Docutils 0.18.1 and Docutils 0.19 support.
• LaTeX: the xcolor package is now required (but is for example part of Ubuntu texlive-latex-recommended which has always been required).
• LaTeX: the fontawesome5 LaTeX package is needed for the default choices of icons now used in admonition titles in PDF output; but if unavailable the PDF build will simply silently omit rendering such icons. Check the documentation of the iconpackage key of :ref:`'sphinxsetup' <latexsphinxsetup>` for more.

Deprecated

• LaTeX: the sphinxlightbox environment is not used anymore, all types of admonitions use (by default) only sphinxheavybox.

Features added

• Support the officially recommended_ .jinja suffix for template files.
• Flatten Union[Literal[T], Literal[U], ...] to Literal[T, U, ...] when turning annotations into strings.
• sphinx.ext.extlinks: Add extlink-{name} CSS class to links.
• Improve CLI progress message, when copying assets.
• Add :attr:.BuildEnvironment.parser.
• Add :attr:.Sphinx.fresh_env_used.
• Add detection of ambiguous std:label and std:term references during loading and resolution of Intersphinx targets.
• Do not duplicate "navigation" in aria-label of built-in themes.
• Include project name in logo_alt of built-in themes.
• Add :option:sphinx-apidoc --remove-old option.
• Add :option:sphinx-autogen --remove-old option.
• Add warning subtype toc.no_title.
• Add helper methods for parsing reStructuredText content into nodes from within a directive.

• :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_content_to_nodes()` parses the directive's content and returns a list of Docutils nodes.
• :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_text_to_nodes()` parses the provided text and returns a list of Docutils nodes.
• :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_inline()` parses the provided text into inline elements and text nodes.

• Support typing_extensions.Unpack
• Add a class option to the :rst:dir:`toctree` directive.
• Add the :rst:dir:`confval` directive.

*

• :confval:c_id_attributes, :confval:c_paren_attributes,
• :confval:cpp_id_attributes, and :confval:cpp_paren_attributes can now be a tuple of strings.
• :confval:c_extra_keywords, :confval:gettext_additional_targets,
• :confval:html_domain_indices, :confval:latex_domain_indices, and :confval:texinfo_domain_indices, can now be a set of strings.

• Added configuration option, :confval:math_numsep, to define the separator for math numbering.
• Add :confval:coverage_modules to the coverage builder to allow explicitly specifying which modules should be documented.
• Add a :rst:dir:`py:type` directive for documenting type aliases, and a :rst:role:`py:type` role for linking to them.
• Add optional description argument to :meth:.Sphinx.add_config_value.
• Prohibit module import cycles in :mod:sphinx.ext.autosummary.
• LaTeX: Revamped styling of all admonitions, with addition of a title row with icon.
• Display :py:class:`~typing.Annotated` annotations with their metadata in the Python domain.
• Add heading-level option to :rst:dir:`rubric` directive.
• Add the :event:write-started event.

Bugs fixed

• Properly format collections.abc.Callable in annotations.
• Fix a performance regression in the C domain that has been present since version 3.0.0.
• Fix removal of anchors from search summaries (regression in 7.3.0).
• Fix merge_domaindata() in sphinx.ext.duration.
• Properly detect WebP files.
• LaTeX: Footnote mark sometimes indicates Page N where N is the current page number and the footnote does appear on that same page.
• LaTeX: for French and 'lualatex' as :confval:latex_engine polyglossia and not babel is used (contrarily to 'xelatex').
• Ensure that configuration setting aliases are always synchronised when one value or the other is modified.
• Fix loading custom template translations for en locale.
• Add valid-type arguments to the linkcheck_rate_limit_timeout configuration setting.
• Resolve data-URI-image-extraction regression from v7.3.0 affecting builders without native support for data-URIs in their output format.
• Fix invalid genindex.html file produced with translated docs (regression in 7.1.0).
• Omit anchor references from document title entries in the search index, removing duplication of search results.
• Use Docutils' SVG processing in the HTML builder and remove Sphinx's custom logic.
• Adjust scoring of matches during HTML search so that document main titles tend to rank higher than subsection titles. In addition, boost matches on the name of programming domain objects relative to title/subtitle matches.
• Do not add a fallback language by stripping the country code.
• Add domain objects to the table of contents in the same order as defined in the document. Previously, each domain used language-specific nesting rules, which removed control from document authors.
• linkcheck: Ignore URLs that respond with non-Unicode content.
• Fix :pep:695 formatting for LaTeX output.

Testing

• karma: refactor HTML search tests to use fixtures generated by Sphinx.

[Bruce Dubbs]

Fixed at commits

ef43aa3570 Update to sphinx-7.4.4 (Python module).
5ef9d065d4 Update to c-ares-1.32.2.