chore(deps): update dependency docs/sphinx to v7
Metadata
Current evaluation
Merged automated dependency update for docs/sphinx to v7.1.2. Approved by a maintainer, passed CI checks, and integrated into main with a single line change.
Suggested action: —
No scores available.
Issue body
Requesting @mr-cal approval since I modified this. — @lengau
[](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.2,<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.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-712-released-Aug-02-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.1.1...v7.1.2)
\=====================================
## Bugs fixed
- [#​11542](https://togithub.com/sphinx-doc/sphinx/issues/11542): linkcheck: Properly respect :confval:`linkcheck_anchors`
and do not spuriously report failures to validate anchors.
Patch by James Addison.
### [`v7.1.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-711-released-Jul-27-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.1.0...v7.1.1)
\=====================================
## Bugs fixed
- [#​11514](https://togithub.com/sphinx-doc/sphinx/issues/11514): Fix `SOURCE_DATE_EPOCH` in multi-line copyright footer.
Patch by Bénédikt Tran.
### [`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 James Addison.
- [#​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/starbase).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi40My4yIiwidXBkYXRlZEluVmVyIjoiMzYuNDMuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged automated dependency update for docs/sphinx to v7.1.2. Approved by a maintainer, passed CI checks, and integrated into main with a single line change. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged automated dependency update upgrading docs/sphinx to v7.1.2. The change passed coverage checks and was manually merged since automatic merging was disabled in configuration. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #180 chore(deps): update dependency docs/sphinx to v7 | craft-cli | merged | Merged an automated dependency update for docs/sphinx to v7.2.6 via Renovate bot. The change received approval, passed CI checks, and was successfully integrated into the main branch. | |
| #128 chore(deps): update dependency docs/sphinx to v7 | craft-application | merged | Merged automated dependency update upgrading docs/sphinx from v6.x to v7.2.6. The change incorporates Sphinx v7 features, bug fixes, and Python 3.8 removal. CI passed, reviews were approved, and the branch was successfully merged into main. | |
| #538 chore(deps): update documentation dependencies (major) | rockcraft | merged | Merged automated dependency update upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. Approved by reviewers, passed CI, and merged with a minimal two-line change. | |
| #141 chore(deps): update dependency docs/sphinx-lint to v0.8.1 | starbase | merged | Merged automated dependency update upgrading docs/sphinx-lint from v0.6.8 to v0.8.1. Approved by reviewers, passed CI checks, and successfully merged into main. | |
| #166 chore(deps): update dependency docs/sphinx-lint to v0.9.1 | starbase | merged | Merged an automated dependency update upgrading docs/sphinx-lint from v0.9.0 to v0.9.1. The change was approved, passed CI and coverage checks, and successfully merged with a single line modification. | |
| #191 chore(deps): update dependency docs/sphinx-lint to v0.8.1 | craft-cli | merged | Merged automated dependency update for docs/sphinx-lint from v0.6.8 to v0.8.1. Approved by reviewer, passed CI checks, and merged without coverage changes. | |
| #160 chore(deps): update dependency docs/sphinx-lint to v0.9.1 | craft-application | merged | Merged automated dependency update for docs/sphinx-lint from v0.8.1 to v0.9.1. Approved by two reviewers, passed CI checks, and maintained 99.19% test coverage. | |
| #152 chore(deps): update dependency docs/sphinx-lint to v0.9.0 | starbase | merged | Automated dependency update for docs/sphinx-lint from v0.8.1 to v0.9.0 was approved by two reviewers, passed all CI checks with 100% test coverage, and successfully merged. | |
| #734 chore(deps): update documentation dependencies | craft-parts | closed | Merged automated updates for documentation dependencies. Upgraded Sphinx to 7.3.7, furo to 2024.5.6, sphinx-autobuild to 2024.4.16, and sphinx-autodoc-typehints to 2.1.0. CI passed and review was approved prior to merge. | |
| #174 chore(deps): update documentation dependencies | craft-store | merged | Merged automated documentation dependency updates via Renovate. Updated Sphinx to 7.3.7, sphinx-design to 0.6.0, sphinx-notfound-page to 1.0.2, and sphinx-reredirects to 0.1.4. Approved by two reviewers, passed CI, and merged. |