⬆️ 🛠️(deps): update dependency sphinx to v7.4.7 #390
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
7.3.7
->7.4.7
Release Notes
sphinx-doc/sphinx (sphinx)
v7.4.7
Compare Source
=====================================
Bugs fixed
Patch by Adam Turner and Bénédikt Tran.
Patch by Adam Turner.
~typing.Annotated
typemetadata in the Python domain.
Patch by Adam Turner.
~typing.Annotated
warnings withsphinx.ext.autodoc
,especially when using :mod:
dataclasses
as type metadata.Patch by Adam Turner.
!autolink
.Patch by Adam Turner.
v7.4.6
Compare Source
=====================================
Bugs fixed
generating autosummary directives for modules within a package.
Patch by Adam Turner.
Patch by James Addison.
v7.4.5
Compare Source
=====================================
Bugs fixed
html_sidebars
values to a list.
Log an error message when string values are detected.
Patch by Adam Turner.
seealso
and other "light" admonitionsnow break PDF builds if they contain a :dudir:
figure
directive; and alsoif they are contained in a table cell (rendered by
tabulary
).Patch by Jean-François B.
v7.4.4
Compare Source
=====================================
Bugs fixed
case-insensitively ambiguous duplicate items.
Patch by James Addison.
v7.4.3
Compare Source
=====================================
Bugs fixed
source_suffix
valueswith extensions that register parsers.
Patch by Adam Turner.
v7.4.2
Compare Source
=====================================
Bugs fixed
with Sphinx 7.3.7 and earlier.
Patch by Adam Turner.
v7.4.1
Compare Source
=====================================
Bugs fixed
heading-level
is used.Patch by Adam Turner.
typing.ParamSpec
in autodoc.Patch by Adam Turner.
v7.4.0
Compare Source
=====================================
Dependencies
Patch by Adam Turner.
xcolor
package is now required (but is for example part ofUbuntu
texlive-latex-recommended
which has always been required).fontawesome5
LaTeX package is needed for the default choicesof 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
sphinxlightbox
environment is not used anymore, all typesof admonitions use (by default) only
sphinxheavybox
.Features added
.. rst-class:: compact
#11165: Support the
officially recommended
_.jinja
suffix for templatefiles.
Patch by James Addison and Adam Turner
.. _officially recommended: https://jinja.palletsprojects.com/en/latest/templates/#template-file-extension
#12325: Flatten
Union[Literal[T], Literal[U], ...]
toLiteral[T, U, ...]
when turning annotations into strings.
Patch by Adam Turner.
#12319:
sphinx.ext.extlinks
: Addextlink-{name}
CSS class to links.Patch by Hugo van Kemenade.
#12387: Improve CLI progress message, when copying assets.
Patch by INADA Nakoi and Bénédikt Tran.
#12361: Add :attr:
.BuildEnvironment.parser
.Patch by Chris Sewell.
#12358: Add :attr:
.Sphinx.fresh_env_used
.Patch by Chris Sewell.
#12329: Add detection of ambiguous
std:label
andstd:term
references duringloading and resolution of Intersphinx targets.
Patch by James Addison.
#12422: Do not duplicate "navigation" in aria-label of built-in themes.
Patch by Thomas Weißschuh
#12421: Include project name in
logo_alt
of built-in themes.Patch by Thomas Weißschuh
#12448: Add :option:
sphinx-apidoc --remove-old
option.Patch by Chris Sewell.
#12456: Add :option:
sphinx-autogen --remove-old
option.Patch by Chris Sewell.
#12479: Add warning subtype
toc.no_title
.Patch by Ondřej Navrátil.
#12492: Add helper methods for parsing reStructuredText content into nodes from
within a directive.
~sphinx.util.docutils.SphinxDirective.parse_content_to_nodes()
parses the directive's content and returns a list of Docutils nodes.
~sphinx.util.docutils.SphinxDirective.parse_text_to_nodes()
parses the provided text and returns a list of Docutils nodes.
~sphinx.util.docutils.SphinxDirective.parse_inline()
parses the provided text into inline elements and text nodes.
Patch by Adam Turner.
#12258: Support
typing_extensions.Unpack
Patch by Bénédikt Tran and Adam Turner.
#12524: Add a
class
option to the :rst:dir:toctree
directive.Patch by Tim Hoffmann.
#12536: Add the :rst:dir:
confval
directive.Patch by Adam Turner.
#12537: :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.
Patch by Adam Turner.
#12523: Added configuration option, :confval:
math_numsep
, to define theseparator for math numbering.
Patch by Thomas Fanning
#11592: Add :confval:
coverage_modules
to the coverage builderto allow explicitly specifying which modules should be documented.
Patch by Stephen Finucane.
#7896, #11989: Add a :rst:dir:
py:type
directive for documenting type aliases,and a :rst:role:
py:type
role for linking to them.Patch by Ashley Whetter.
#12549: Add optional
description
argument to:meth:
.Sphinx.add_config_value
.Patch by Chris Sewell.
#6792: Prohibit module import cycles in :mod:
sphinx.ext.autosummary
.Patch by Trevor Bekolay.
#12508: LaTeX: Revamped styling of all admonitions, with addition of a
title row with icon.
Patch by Jean-François B.
#11773: Display :py:class:
~typing.Annotated
annotationswith their metadata in the Python domain.
Patch by Adam Turner and David Stansby.
#12506: Add
heading-level
option to :rst:dir:rubric
directive.Patch by Chris Sewell.
#12567: Add the :event:
write-started
event.Patch by Chris Sewell.
Bugs fixed
collections.abc.Callable
in annotations.Patch by Adam Turner.
been present since version 3.0.0.
Patch by Donald Hunter.
Patch by Will Lachance.
merge_domaindata()
insphinx.ext.duration
.Patch by Matthias Geier.
Patch by Benjamin Cabé.
Page N
whenN
is alreadythe current page number.
Patch by Jean-François B.
'lualatex'
as :confval:latex_engine
use
babel
as with'xelatex'
(and notpolyglossia
).Patch by Jean-François B.
todolist
produce correct hyperlinks in PDF.Patch by Jean-François B.
when one value or the other is modified.
Patch by Bénédikt Tran.
en
locale.Patch by Nicolas Peugnet.
linkcheck_rate_limit_timeout
configuration setting.
Patch by James Addison.
builders without native support for data-URIs in their output format.
Patch by James Addison.
(regression in 7.1.0).
Patch by Nicolas Peugnet.
removing duplication of search results.
Patch by James Addison.
and remove Sphinx's custom logic.
Patch by Tunç Başar Köse.
titles tend to rank higher than subsection titles. In addition, boost matches
on the name of programming domain objects relative to title/subtitle matches.
Patch by James Addison and Will Lachance.
Patch by Alvin Wong.
in the same order as defined in the document.
Previously, each domain used language-specific nesting rules,
which removed control from document authors.
Patch by Jakob Lykke Andersen and Adam Turner.
Patch by James Addison.
695
formatting for LaTeX output.Patch by Bénédikt Tran.
Testing
Patch by James Addison.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.