build(deps): update dependency sphinx to v7.4.7 (main)
Metadata
Current evaluation
Merged PR #867 as commit 0124eff7, updating the pinned Sphinx dependency from 7.3.7 to 7.4.7.
Resolution: closed resolved
Reason: PR #867 was approved and merged into main as commit 0124eff7, applying the Sphinx 7.4.7 dependency update.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [Sphinx](https://redirect.github.com/sphinx-doc/sphinx) ([changelog](https://www.sphinx-doc.org/en/master/changes.html)) | `==7.3.7` -> `==7.4.7` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) |
---
> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency Dashboard for more information.
---
### Release Notes
<details>
<summary>sphinx-doc/sphinx (Sphinx)</summary>
### [`v7.4.7`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-747-released-Jul-20-2024)
[Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.6...v7.4.7)
\=====================================
## Bugs fixed
- [#​12096](https://redirect.github.com/sphinx-doc/sphinx/issues/12096): Warn when files are overwritten in the build directory.
Patch by Adam Turner and Bénédikt Tran.
- [#​12620](https://redirect.github.com/sphinx-doc/sphinx/issues/12620): Ensure that old-style object description options are respected.
Patch by Adam Turner.
- [#​12601](https://redirect.github.com/sphinx-doc/sphinx/issues/12601), [#​12625](https://redirect.github.com/sphinx-doc/sphinx/issues/12625): Support callable objects in :py:class:`~typing.Annotated` type
metadata in the Python domain.
Patch by Adam Turner.
- [#​12601](https://redirect.github.com/sphinx-doc/sphinx/issues/12601), [#​12622](https://redirect.github.com/sphinx-doc/sphinx/issues/12622): Resolve :py:class:`~typing.Annotated` warnings with
`sphinx.ext.autodoc`,
especially when using :mod:`dataclasses` as type metadata.
Patch by Adam Turner.
- [#​12589](https://redirect.github.com/sphinx-doc/sphinx/issues/12589), [#​12626](https://redirect.github.com/sphinx-doc/sphinx/issues/12626): autosummary: Fix warnings with :rst:role:`!autolink`.
Patch by Adam Turner.
### [`v7.4.6`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-746-released-Jul-18-2024)
[Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.5...v7.4.6)
\=====================================
## Bugs fixed
- [#​12589](https://redirect.github.com/sphinx-doc/sphinx/issues/12589), [#​9743](https://redirect.github.com/sphinx-doc/sphinx/issues/9743), [#​12609](https://redirect.github.com/sphinx-doc/sphinx/issues/12609): autosummary: Do not add the package prefix when
generating autosummary directives for modules within a package.
Patch by Adam Turner.
- [#​12613](https://redirect.github.com/sphinx-doc/sphinx/issues/12613): Reduce log severity for ambiguity detection during inventory loading.
Patch by James Addison.
### [`v7.4.5`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-745-released-Jul-16-2024)
[Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.4...v7.4.5)
\=====================================
## Bugs fixed
- [#​12593](https://redirect.github.com/sphinx-doc/sphinx/issues/12593), [#​12600](https://redirect.github.com/sphinx-doc/sphinx/issues/12600): Revert coercing the type of selected :confval:`html_sidebars`
values to a list.
Log an error message when string values are detected.
Patch by Adam Turner.
- [#​12594](https://redirect.github.com/sphinx-doc/sphinx/issues/12594): LaTeX: since 7.4.0, :rst:dir:`seealso` and other "light" admonitions
now break PDF builds if they contain a :dudir:`figure` directive; and also
if they are contained in a table cell (rendered by `tabulary`).
Patch by Jean-François B.
### [`v7.4.4`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-744-released-Jul-15-2024)
[Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.3...v7.4.4)
\=====================================
## Bugs fixed
- [#​12585](https://redirect.github.com/sphinx-doc/sphinx/issues/12585), [#​12586](https://redirect.github.com/sphinx-doc/sphinx/issues/12586): Do not warn when an intersphinx inventory contains
case-insensitively ambiguous duplicate items.
Patch by James Addison.
### [`v7.4.3`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-743-released-Jul-15-2024)
[Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.2...v7.4.3)
\=====================================
## Bugs fixed
- [#​12582](https://redirect.github.com/sphinx-doc/sphinx/issues/12582): Restore support for list-styled :confval:`source_suffix` values
with extensions that register parsers.
Patch by Adam Turner.
### [`v7.4.2`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-742-released-Jul-15-2024)
[Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.1...v7.4.2)
\=====================================
## Bugs fixed
- [#​12580](https://redirect.github.com/sphinx-doc/sphinx/issues/12580), [#​12583](https://redirect.github.com/sphinx-doc/sphinx/issues/12583): Resolve failures with the C domain on incremental builds
with Sphinx 7.3.7 and earlier.
Patch by Adam Turner.
### [`v7.4.1`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-741-released-Jul-15-2024)
[Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.0...v7.4.1)
\=====================================
## Bugs fixed
- Fix invalid HTML when a rubric node with invalid `heading-level` is used.
Patch by Adam Turner.
- [#​12579](https://redirect.github.com/sphinx-doc/sphinx/issues/12579), [#​12581](https://redirect.github.com/sphinx-doc/sphinx/issues/12581): Restore support for `typing.ParamSpec` in autodoc.
Patch by Adam Turner.
### [`v7.4.0`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-740-released-Jul-15-2024)
[Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.3.7...v7.4.0)
\=====================================
## Dependencies
- [#​12555](https://redirect.github.com/sphinx-doc/sphinx/issues/12555): Drop Docutils 0.18.1 and Docutils 0.19 support.
Patch by Adam Turner.
- 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
.. rst-class:: compact
- [#​11165](https://redirect.github.com/sphinx-doc/sphinx/issues/11165): Support the `officially recommended`\_ `.jinja` suffix for template
files.
Patch by James Addison and Adam Turner
.. \_officially recommended: https://jinja.palletsprojects.com/en/latest/templates/#template-file-extension
- [#​12325](https://redirect.github.com/sphinx-doc/sphinx/issues/12325): Flatten `Union[Literal[T], Literal[U], ...]` to `Literal[T, U, ...]`
when turning annotations into strings.
Patch by Adam Turner.
- [#​12319](https://redirect.github.com/sphinx-doc/sphinx/issues/12319): `sphinx.ext.extlinks`: Add `extlink-{name}` CSS class to links.
Patch by Hugo van Kemenade.
- [#​12387](https://redirect.github.com/sphinx-doc/sphinx/issues/12387): Improve CLI progress message, when copying assets.
Patch by INADA Nakoi and Bénédikt Tran.
- [#​12361](https://redirect.github.com/sphinx-doc/sphinx/issues/12361): Add :attr:`.BuildEnvironment.parser`.
Patch by Chris Sewell.
- [#​12358](https://redirect.github.com/sphinx-doc/sphinx/issues/12358): Add :attr:`.Sphinx.fresh_env_used`.
Patch by Chris Sewell.
- [#​12329](https://redirect.github.com/sphinx-doc/sphinx/issues/12329): Add detection of ambiguous `std:label` and `std:term` references during
loading and resolution of Intersphinx targets.
Patch by James Addison.
- [#​12422](https://redirect.github.com/sphinx-doc/sphinx/issues/12422): Do not duplicate "navigation" in aria-label of built-in themes.
Patch by Thomas Weißschuh
- [#​12421](https://redirect.github.com/sphinx-doc/sphinx/issues/12421): Include project name in `logo_alt` of built-in themes.
Patch by Thomas Weißschuh
- [#​12448](https://redirect.github.com/sphinx-doc/sphinx/issues/12448): Add :option:`sphinx-apidoc --remove-old` option.
Patch by Chris Sewell.
- [#​12456](https://redirect.github.com/sphinx-doc/sphinx/issues/12456): Add :option:`sphinx-autogen --remove-old` option.
Patch by Chris Sewell.
- [#​12479](https://redirect.github.com/sphinx-doc/sphinx/issues/12479): Add warning subtype `toc.no_title`.
Patch by Ondřej Navrátil.
- [#​12492](https://redirect.github.com/sphinx-doc/sphinx/issues/12492): 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.
Patch by Adam Turner.
- [#​12258](https://redirect.github.com/sphinx-doc/sphinx/issues/12258): Support `typing_extensions.Unpack`
Patch by Bénédikt Tran and Adam Turner.
- [#​12524](https://redirect.github.com/sphinx-doc/sphinx/issues/12524): Add a `class` option to the :rst:dir:`toctree` directive.
Patch by Tim Hoffmann.
- [#​12536](https://redirect.github.com/sphinx-doc/sphinx/issues/12536): Add the :rst:dir:`confval` directive.
Patch by Adam Turner.
- [#​12537](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12523): Added configuration option, :confval:`math_numsep`, to define the
separator for math numbering.
Patch by Thomas Fanning
- [#​11592](https://redirect.github.com/sphinx-doc/sphinx/issues/11592): Add :confval:`coverage_modules` to the coverage builder
to allow explicitly specifying which modules should be documented.
Patch by Stephen Finucane.
- [#​7896](https://redirect.github.com/sphinx-doc/sphinx/issues/7896), [#​11989](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12549): Add optional `description` argument to
:meth:`.Sphinx.add_config_value`.
Patch by Chris Sewell.
- [#​6792](https://redirect.github.com/sphinx-doc/sphinx/issues/6792): Prohibit module import cycles in :mod:`sphinx.ext.autosummary`.
Patch by Trevor Bekolay.
- [#​12508](https://redirect.github.com/sphinx-doc/sphinx/issues/12508): LaTeX: Revamped styling of all admonitions, with addition of a
title row with icon.
Patch by Jean-François B.
- [#​11773](https://redirect.github.com/sphinx-doc/sphinx/issues/11773): Display :py:class:`~typing.Annotated` annotations
with their metadata in the Python domain.
Patch by Adam Turner and David Stansby.
- [#​12506](https://redirect.github.com/sphinx-doc/sphinx/issues/12506): Add `heading-level` option to :rst:dir:`rubric` directive.
Patch by Chris Sewell.
- [#​12567](https://redirect.github.com/sphinx-doc/sphinx/issues/12567): Add the :event:`write-started` event.
Patch by Chris Sewell.
## Bugs fixed
- [#​12314](https://redirect.github.com/sphinx-doc/sphinx/issues/12314): Properly format `collections.abc.Callable` in annotations.
Patch by Adam Turner.
- [#​12162](https://redirect.github.com/sphinx-doc/sphinx/issues/12162): Fix a performance regression in the C domain that has
been present since version 3.0.0.
Patch by Donald Hunter.
- [#​12320](https://redirect.github.com/sphinx-doc/sphinx/issues/12320): Fix removal of anchors from search summaries (regression in 7.3.0).
Patch by Will Lachance.
- [#​12251](https://redirect.github.com/sphinx-doc/sphinx/issues/12251): Fix `merge_domaindata()` in `sphinx.ext.duration`.
Patch by Matthias Geier.
- [#​12224](https://redirect.github.com/sphinx-doc/sphinx/issues/12224): Properly detect WebP files.
Patch by Benjamin Cabé.
- [#​12380](https://redirect.github.com/sphinx-doc/sphinx/issues/12380): LaTeX: Avoid footnote markers `Page N` when `N` is already
the current page number.
Patch by Jean-François B.
- [#​12410](https://redirect.github.com/sphinx-doc/sphinx/issues/12410): LaTeX: for French and `'lualatex'` as :confval:`latex_engine`
use `babel` as with `'xelatex'` (and not `polyglossia`).
Patch by Jean-François B.
- [#​12520](https://redirect.github.com/sphinx-doc/sphinx/issues/12520): LaTeX: let :rst:dir:`todolist` produce correct hyperlinks in PDF.
Patch by Jean-François B.
- [#​12416](https://redirect.github.com/sphinx-doc/sphinx/issues/12416): Ensure that configuration setting aliases are always synchronised
when one value or the other is modified.
Patch by Bénédikt Tran.
- [#​12220](https://redirect.github.com/sphinx-doc/sphinx/issues/12220): Fix loading custom template translations for `en` locale.
Patch by Nicolas Peugnet.
- [#​12459](https://redirect.github.com/sphinx-doc/sphinx/issues/12459): Add valid-type arguments to the `linkcheck_rate_limit_timeout`
configuration setting.
Patch by James Addison.
- [#​12331](https://redirect.github.com/sphinx-doc/sphinx/issues/12331): Resolve data-URI-image-extraction regression from v7.3.0 affecting
builders without native support for data-URIs in their output format.
Patch by James Addison.
- [#​12494](https://redirect.github.com/sphinx-doc/sphinx/issues/12494): Fix invalid genindex.html file produced with translated docs
(regression in 7.1.0).
Patch by Nicolas Peugnet.
- [#​11961](https://redirect.github.com/sphinx-doc/sphinx/issues/11961): Omit anchor references from document title entries in the search index,
removing duplication of search results.
Patch by James Addison.
- [#​12425](https://redirect.github.com/sphinx-doc/sphinx/issues/12425): Use Docutils' SVG processing in the HTML builder
and remove Sphinx's custom logic.
Patch by Tunç Başar Köse.
- [#​12391](https://redirect.github.com/sphinx-doc/sphinx/issues/12391): 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.
Patch by James Addison and Will Lachance.
- [#​9634](https://redirect.github.com/sphinx-doc/sphinx/issues/9634): Do not add a fallback language by stripping the country code.
Patch by Alvin Wong.
- [#​12352](https://redirect.github.com/sphinx-doc/sphinx/issues/12352): 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.
Patch by Jakob Lykke Andersen and Adam Turner.
- [#​11041](https://redirect.github.com/sphinx-doc/sphinx/issues/11041): linkcheck: Ignore URLs that respond with non-Unicode content.
Patch by James Addison.
- [#​12543](https://redirect.github.com/sphinx-doc/sphinx/issues/12543): Fix :pep:`695` formatting for LaTeX output.
Patch by Bénédikt Tran.
## Testing
- karma: refactor HTML search tests to use fixtures generated by Sphinx.
Patch by James Addison.
</details>
---
### Configuration
📅 **Schedule**: Branch creation - "every weekend" in timezone Etc/UTC, Automerge - At any time (no schedule defined).
🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.
♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 **Ignore**: Close this PR and you won't be reminded about this update again.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box
---
This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/canonical/craft-parts).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC45Ny4wIiwidXBkYXRlZEluVmVyIjoiMzguOTcuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #867 as commit 0124eff7, updating the pinned Sphinx dependency from 7.3.7 to 7.4.7. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/craft-parts#867 as 0124eff7, updating the pinned Sphinx dependency from 7.3.7 to 7.4.7. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged automated dependency update upgrading Sphinx from v7.3.7 to v7.4.7. Approved by reviewers, passed CI, and integrated into the main branch. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged an automated dependency update upgrading Sphinx from v7.3.7 to v7.4.7 on the main branch. The change incorporates bug fixes and new features from the Sphinx 7.4.x release series. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #233 build(deps): update dependency sphinx to v8.1.3 | craft-store | merged | Merged PR #233 upgraded Sphinx from 8.0.2 to 8.1.3 in two dependency files via commit 4519f1a. | |
| #228 build(deps): update dependency sphinx to v8 | craft-store | merged | Merged #228 via commit c5b2772, updating Sphinx from 7.4.7 to 8.0.2 in two dependency files. | |
| #873 build(deps): update dependency sphinx to v8 (main) | craft-parts | closed | Renovate PR #873 proposed upgrading Sphinx from 7.4.7 to 8.1.2, but it was closed unmerged; Renovate then marked the 8.x update as ignored. | |
| #483 build(deps): update dependency canonical-sphinx to v0.7.0 (main) | craft-cli | merged | Renovate PR merged into main: bumped canonical-sphinx from ==0.6.0 to ==0.7.0 in docs requirements plus lockfile (2 files, +5/-5), approved with all CI checks green. | |
| #1013 build(deps): update dependency canonical-sphinx to ~=0.7.1 (main) | craft-providers | merged | Merged dependency update for canonical-sphinx from ~=0.6.0 to ~=0.7.1. | |
| #170 build(deps): update dependency canonical-sphinx to ~=0.6.0 (main) | craft-grammar | merged | Merged PR #170 via commit c61511f, updating canonical-sphinx from ~=0.5.0 to ~=0.6.0 after three approvals and a fully passing CI run. | |
| #714 build(deps): update dependency canonical-sphinx to ~=0.4.0 (main) | craft-application | merged | Renovate PR bumping canonical-sphinx from ~=0.2.0 to ~=0.4.0 was approved (2 reviewers) and merged into main as commit 83fb6e5a; pin later advanced to ~=0.5.1 (#818) and ~=0.6.0 (#1021). | |
| #660 build(deps): update dependency sphinx-lint to v1 | craft-providers | merged | Renovate PR #660 was merged, updating sphinx-lint from 0.9.1 to 1.0.0; the change landed in commits 7494548 and abb814b. | |
| #229 build(deps): update dependency sphinx-lint to v1 | craft-store | merged | Merged PR #229 upgraded sphinx-lint from 0.9.1 to 1.0.0 in commit 65cc856, updating two dependency files. | |
| #224 build(deps): update dependency sphinx-autobuild to v2024.10.3 | craft-store | merged | Renovate PR merged as commit d507527, bumping sphinx-autobuild from ==2024.9.19 to ==2024.10.3 (+2/-2 lines across two dependency files); pin still present in docs/.sphinx/requirements.txt. |