chore(deps): update dependency docs/sphinx to v7
Metadata
Current evaluation
Renovate PR #365 bumped docs/sphinx from >=6.2.1,<7.0 to >=7.1,<7.2 in docs requirements and was merged into main as commit 72962a5, retried after sphinx-design issue #130 was fixed.
Resolution: closed resolved
Reason: The PR was approved and merged into main, landing as commit 72962a5 ("chore(deps): update dependency docs/sphinx to v7 (#365)") which changes the docs/sphinx pin from >=6.2.1,<7.0 to >=7.1,<7.2.
Evaluated by: mr-cal-bot
No scores available.
Issue body
[](https://renovatebot.com)
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [docs/sphinx](https://togithub.com/sphinx-doc/sphinx) ([changelog](https://www.sphinx-doc.org/en/master/changes.html)) | `>=6.2.1,<7.0` -> `>=7.1,<7.2` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) |
---
### Release Notes
<details>
<summary>sphinx-doc/sphinx (docs/sphinx)</summary>
### [`v7.1.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-710-released-Jul-24-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.0.1...v7.1.0)
\=====================================
## Incompatible changes
- Releases are no longer signed, given the `change in PyPI policy`\_.
.. \_change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
## Deprecated
- [#​11412](https://togithub.com/sphinx-doc/sphinx/issues/11412): Emit warnings on using a deprecated Python-specific index entry type
(namely, `module`, `keyword`, `operator`, `object`, `exception`,
`statement`, and `builtin`) in the :rst:dir:`index` directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.
## Features added
- [#​11415](https://togithub.com/sphinx-doc/sphinx/issues/11415): Add a checksum to JavaScript and CSS asset URIs included within
generated HTML, using the CRC32 algorithm.
- :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version
requirement to be specified as `(major, minor)`.
- [#​11011](https://togithub.com/sphinx-doc/sphinx/issues/11011): Allow configuring a line-length limit for object signatures, via
:confval:`maximum_signature_line_length` and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:`py:function:single-line-parameter-list`.
Patch by Thomas Louf, Adam Turner, and Jean-François B.
- [#​10983](https://togithub.com/sphinx-doc/sphinx/issues/10983): Support for multiline copyright statements in the footer block.
Patch by Stefanie Molin
- `sphinx.util.display.status_iterator` now clears the current line
with ANSI control codes, rather than overprinting with space characters.
- [#​11431](https://togithub.com/sphinx-doc/sphinx/issues/11431): linkcheck: Treat SSL failures as broken links.
Patch by Bénédikt Tran
- [#​11157](https://togithub.com/sphinx-doc/sphinx/issues/11157): Keep the `translated` attribute on translated nodes.
- [#​11451](https://togithub.com/sphinx-doc/sphinx/issues/11451): Improve the traceback displayed when using :option:`sphinx-build -T`
in parallel builds. Patch by Bénédikt Tran
- [#​11324](https://togithub.com/sphinx-doc/sphinx/issues/11324): linkcheck: Use session-basd HTTP requests.
- [#​11438](https://togithub.com/sphinx-doc/sphinx/issues/11438): Add support for the :rst:dir:`py:class` and :rst:dir:`py:function`
directives for PEP 695 (generic classes and functions declarations) and
PEP 696 (default type parameters). Multi-line support ([#​11011](https://togithub.com/sphinx-doc/sphinx/issues/11011)) is enabled
for type parameters list and can be locally controlled on object description
directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`.
Patch by Bénédikt Tran.
- [#​11484](https://togithub.com/sphinx-doc/sphinx/issues/11484): linkcheck: Allow HTML anchors to be ignored on a per-URL basis
via :confval:`linkcheck_anchors_ignore_for_url` while
still checking the validity of the page itself.
Patch by Bénédikt Tran
- [#​1246](https://togithub.com/sphinx-doc/sphinx/issues/1246): Add translation progress statistics and inspection support,
via a new substitution (`|translation progress|`) and a new
configuration variable (:confval:`translation_progress_classes`).
These enable determining the percentage of translated elements within
a document, and the remaining translated and untranslated elements.
## Bugs fixed
- Restored the `footnote-reference` class that has been removed in
the latest (unreleased) version of Docutils.
- [#​11486](https://togithub.com/sphinx-doc/sphinx/issues/11486): Use :rfc:`8081` font file MIME types in the EPUB builder.
Using the correct MIME type will prevent warnings from `epubcheck`
and will generate a valid EPUB.
- [#​11435](https://togithub.com/sphinx-doc/sphinx/issues/11435): Use microsecond-resolution timestamps for outdated file detection
in `BuildEnvironment.get_outdated_files`.
- [#​11437](https://togithub.com/sphinx-doc/sphinx/issues/11437): Top-level headings starting with a reStructuredText role
now render properly when :confval:`rst_prolog` is set.
Previously, a file starting with the below would have
improperly rendered due to where the prologue text
was inserted into the document.
.. code:: rst
# :mod:`lobster` -- The lobster module
...
Patch by Bénédikt Tran.
- [#​11337](https://togithub.com/sphinx-doc/sphinx/issues/11337): Fix a `MemoryError` in `sphinx.ext.intersphinx` when using `None`
or `typing.*` as inline type references. Patch by Bénédikt Tran (picnixz)
## Testing
- [#​11345](https://togithub.com/sphinx-doc/sphinx/issues/11345): Always delete `docutils.conf` in test directories when running
`SphinxTestApp.cleanup()`.
### [`v7.0.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-701-released-May-12-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.0.0...v7.0.1)
\=====================================
## Dependencies
- [#​11411](https://togithub.com/sphinx-doc/sphinx/issues/11411): Support `Docutils 0.20`\_. Patch by Adam Turner.
.. \_Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04
## Bugs fixed
- [#​11418](https://togithub.com/sphinx-doc/sphinx/issues/11418): Clean up remaining references to `sphinx.setup_command`
following the removal of support for setuptools.
Patch by Willem Mulder.
### [`v7.0.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-700-released-Apr-29-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.2.1...v7.0.0)
\=====================================
## Incompatible changes
- [#​11359](https://togithub.com/sphinx-doc/sphinx/issues/11359): Remove long-deprecated aliases for `MecabSplitter` and
`DefaultSplitter` in `sphinx.search.ja`.
- [#​11360](https://togithub.com/sphinx-doc/sphinx/issues/11360): Remove deprecated `make_old_id` functions in domain object
description classes.
- [#​11363](https://togithub.com/sphinx-doc/sphinx/issues/11363): Remove the Setuptools integration (`build_sphinx` hook in
`setup.py`).
- [#​11364](https://togithub.com/sphinx-doc/sphinx/issues/11364): Remove deprecated `sphinx.ext.napoleon.iterators` module.
- [#​11365](https://togithub.com/sphinx-doc/sphinx/issues/11365): Remove support for the `jsdump` format in `sphinx.search`.
- [#​11366](https://togithub.com/sphinx-doc/sphinx/issues/11366): Make `locale` a required argument to
`sphinx.util.i18n.format_date()`.
- [#​11370](https://togithub.com/sphinx-doc/sphinx/issues/11370): Remove deprecated `sphinx.util.stemmer` module.
- [#​11371](https://togithub.com/sphinx-doc/sphinx/issues/11371): Remove deprecated `sphinx.pycode.ast.parse()` function.
- [#​11372](https://togithub.com/sphinx-doc/sphinx/issues/11372): Remove deprecated `sphinx.io.read_doc()` function.
- [#​11373](https://togithub.com/sphinx-doc/sphinx/issues/11373): Removed deprecated `sphinx.util.get_matching_files()` function.
- [#​11378](https://togithub.com/sphinx-doc/sphinx/issues/11378): Remove deprecated `sphinx.util.docutils.is_html5_writer_available()`
function.
- [#​11379](https://togithub.com/sphinx-doc/sphinx/issues/11379): Make the `env` argument to `Builder` subclasses required.
- [#​11380](https://togithub.com/sphinx-doc/sphinx/issues/11380): autosummary: Always emit grouped import exceptions.
- [#​11381](https://togithub.com/sphinx-doc/sphinx/issues/11381): Remove deprecated `style` key for HTML templates.
- [#​11382](https://togithub.com/sphinx-doc/sphinx/issues/11382): Remove deprecated `sphinx.writers.latex.LaTeXTranslator.docclasses`
attribute.
- [#​11383](https://togithub.com/sphinx-doc/sphinx/issues/11383): Remove deprecated `sphinx.builders.html.html5_ready` and
`sphinx.builders.html.HTMLTranslator` attributes.
- [#​11385](https://togithub.com/sphinx-doc/sphinx/issues/11385): Remove support for HTML 4 output.
</details>
---
### Configuration
📅 **Schedule**: Branch creation - "every weekend" in timezone Etc/UTC, Automerge - "every weekend" in timezone Etc/UTC.
🚦 **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 has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/canonical/craft-providers).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMS4wIiwidXBkYXRlZEluVmVyIjoiMzYuMTEuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Renovate PR #365 bumped docs/sphinx from >=6.2.1,<7.0 to >=7.1,<7.2 in docs requirements and was merged into main as commit 72962a5, retried after sphinx-design issue #130 was fixed. | |
| qwen/qwen3.6-35b-a3b | — | closed resolved | Updated docs/sphinx dependency from v6 to v7.1. Merged in PR #365. |
Update history
| Date | Change |
|---|---|
| created |
Related work
-
Related To:
sphinx-design#130
(confidence 70%)
Upstream bug that blocked sphinx v7 and prompted the sphinx-design bump
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #180 chore(deps): update dependency docs/sphinx to v7 | craft-cli | merged | Merged PR #180 as commit 91c4b88, updating docs/sphinx from >=6.2.1,<7.0 to >=7.2.6,<7.3. | |
| #128 chore(deps): update dependency docs/sphinx to v7 | craft-application | merged | Merged PR #128 in commit a9ca6a26, updating docs/sphinx from >=6.2.1,<7.0 to >=7.2.6,<7.3. | |
| #118 chore(deps): update dependency docs/sphinx to v7 | starbase | merged | Merged PR #118 via commit 3fca437, raising the docs/sphinx constraint from >=6.2.1,<7.0 to >=7.1.2,<7.2. | |
| #355 chore(deps): update dependency docs/sphinx to v7 | craft-providers | closed | Closed unmerged after an upstream sphinx-design blocker; the later Sphinx 7 update merged through canonical/craft-providers#365 (commit 72962a5). | |
| #141 chore(deps): update dependency docs/sphinx-lint to v0.8.1 | starbase | merged | Renovate PR #141 was merged, updating docs/sphinx-lint from 0.6.8 to 0.8.1 in commit 62cafda. | |
| #538 chore(deps): update documentation dependencies (major) | rockcraft | merged | Merged PR #538 in commit b007f265, upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. | |
| #368 chore(deps): update documentation dependencies | craft-providers | merged | Renovate dependency bump PR merged as commit 5eae8d4 (2023-07-28): docs/sphinx-lint 0.6.7→0.6.8 and docs/sphinx-toolbox 3.4.0→3.5.0, +2/-2 lines in the docs requirements. | |
| #174 chore(deps): update documentation dependencies | craft-store | merged | Merged Renovate PR #174 via commit 94e5c25, updating documentation dependencies including Sphinx 7.2.6→7.3.7 and sphinx-design 0.5.0→0.6.0. | |
| #641 chore(deps): update dependency canonical-sphinx to v0.7.1 | fetch-service | closed | Renovate dependency bump of canonical-sphinx from 0.6.0 to 0.7.1 was approved and merged into main as commit 015a619, updating docs/requirements.txt (now pins canonical-sphinx==0.7.1). | |
| #60 chore(deps): update dependency docs/sphinx-design to v0.4.1 | starbase | merged | Renovate PR #60 (approved, no comments) bumping docs/sphinx-design from 0.3.0 to 0.4.1 was merged as commit eae3d8a; the pin has since moved on to 0.6.1 in docs/requirements.txt and pyproject.toml. |