chore(deps): update dependency sphinx to v6
Metadata
Current evaluation
Closed without merging because sphinx-design did not support Sphinx 6. Renovate will ignore future 6.x updates for this repository until the blocker is resolved or the dependency is manually upgraded.
Suggested action: —
No scores available.
Issue body
[](https://renovatebot.com)
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [sphinx](https://togithub.com/sphinx-doc/sphinx) ([changelog](https://www.sphinx-doc.org/en/master/changes.html)) | `==5.3.0` -> `==6.1.3` | [](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</summary>
### [`v6.1.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-613-released-Jan-10-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.2...v6.1.3)
\=====================================
## Bugs fixed
- [#​11116](https://togithub.com/sphinx-doc/sphinx/issues/11116): Reverted to previous Sphinx 5 node copying method
- [#​11117](https://togithub.com/sphinx-doc/sphinx/issues/11117): Reverted changes to parallel image processing from Sphinx 6.1.0
- [#​11119](https://togithub.com/sphinx-doc/sphinx/issues/11119): Supress `ValueError` in the `linkcheck` builder
### [`v6.1.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-612-released-Jan-07-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.1...v6.1.2)
\=====================================
## Bugs fixed
- [#​11101](https://togithub.com/sphinx-doc/sphinx/issues/11101): LaTeX: `div.topic_padding` key of sphinxsetup documented at 5.1.0 was
implemented with name `topic_padding`
- [#​11099](https://togithub.com/sphinx-doc/sphinx/issues/11099): LaTeX: `shadowrule` key of sphinxsetup causes PDF build to crash
since Sphinx 5.1.0
- [#​11096](https://togithub.com/sphinx-doc/sphinx/issues/11096): LaTeX: `shadowsize` key of sphinxsetup causes PDF build to crash
since Sphinx 5.1.0
- [#​11095](https://togithub.com/sphinx-doc/sphinx/issues/11095): LaTeX: shadow of :dudir:`topic` and contents\_ boxes not in page
margin since Sphinx 5.1.0
.. \_contents: https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents
- [#​11100](https://togithub.com/sphinx-doc/sphinx/issues/11100): Fix copying images when running under parallel mode.
### [`v6.1.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-611-released-Jan-05-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.0...v6.1.1)
\=====================================
## Bugs fixed
- [#​11091](https://togithub.com/sphinx-doc/sphinx/issues/11091): Fix `util.nodes.apply_source_workaround` for `literal_block` nodes
with no source information in the node or the node's parents.
### [`v6.1.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-610-released-Jan-05-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.0.1...v6.1.0)
\=====================================
## Dependencies
- Adopted the `Ruff`\_ code linter.
.. \_Ruff: https://github.com/charliermarsh/ruff
## Incompatible changes
- [#​10979](https://togithub.com/sphinx-doc/sphinx/issues/10979): gettext: Removed support for pluralisation in `get_translation`.
This was unused and complicated other changes to `sphinx.locale`.
## Deprecated
- `sphinx.util` functions:
- Renamed `sphinx.util.typing.stringify()`
to `sphinx.util.typing.stringify_annotation()`
- Moved `sphinx.util.xmlname_checker()`
to `sphinx.builders.epub3._XML_NAME_PATTERN`
Moved to `sphinx.util.display`:
- `sphinx.util.status_iterator`
- `sphinx.util.display_chunk`
- `sphinx.util.SkipProgressMessage`
- `sphinx.util.progress_message`
Moved to `sphinx.util.http_date`:
- `sphinx.util.epoch_to_rfc1123`
- `sphinx.util.rfc1123_to_epoch`
Moved to `sphinx.util.exceptions`:
- `sphinx.util.save_traceback`
- `sphinx.util.format_exception_cut_frames`
## Features added
- Cache doctrees in the build environment during the writing phase.
- Make all writing phase tasks support parallel execution.
- [#​11072](https://togithub.com/sphinx-doc/sphinx/issues/11072): Use PEP 604 (`X | Y`) display conventions for `typing.Optional`
and `typing.Optional` types within the Python domain and autodoc.
- [#​10700](https://togithub.com/sphinx-doc/sphinx/issues/10700): autodoc: Document `typing.NewType()` types as classes rather than
'data'.
- Cache doctrees between the reading and writing phases.
## Bugs fixed
- [#​10962](https://togithub.com/sphinx-doc/sphinx/issues/10962): HTML: Fix the multi-word key name lookup table.
- Fixed support for Python 3.12 alpha 3 (changes in the `enum` module).
- [#​11069](https://togithub.com/sphinx-doc/sphinx/issues/11069): HTML Theme: Removed outdated "shortcut" link relation keyword.
- [#​10952](https://togithub.com/sphinx-doc/sphinx/issues/10952): Properly terminate parallel processes on programme interuption.
- [#​10988](https://togithub.com/sphinx-doc/sphinx/issues/10988): Speed up `TocTree.resolve()` through more efficient copying.
- [#​6744](https://togithub.com/sphinx-doc/sphinx/issues/6744): LaTeX: support for seealso directive should be via an environment
to allow styling.
- [#​11074](https://togithub.com/sphinx-doc/sphinx/issues/11074): LaTeX: Can't change sphinxnote to use sphinxheavybox starting with
5.1.0
### [`v6.0.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-601-released-Jan-05-2023)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.0.0...v6.0.1)
\=====================================
## Dependencies
- Require Pygments 2.13 or later.
## Bugs fixed
- [#​10944](https://togithub.com/sphinx-doc/sphinx/issues/10944): imgmath: Fix resolving image paths for files in nested folders.
### [`v6.0.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-600-released-Dec-29-2022)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.3.0...v6.0.0)
\=====================================
## Dependencies
- [#​10468](https://togithub.com/sphinx-doc/sphinx/issues/10468): Drop Python 3.6 support
- [#​10470](https://togithub.com/sphinx-doc/sphinx/issues/10470): Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and
Docutils 0.17 support. Patch by Adam Turner
## Incompatible changes
- [#​7405](https://togithub.com/sphinx-doc/sphinx/issues/7405): Removed the jQuery and underscore.js JavaScript frameworks.
These frameworks are no longer be automatically injected into themes from
Sphinx 6.0. If you develop a theme or extension that uses the
`jQuery`, `$`, or `$u` global objects, you need to update your
JavaScript to modern standards, or use the mitigation below.
The first option is to use the sphinxcontrib.jquery\_ extension, which has been
developed by the Sphinx team and contributors. To use this, add
`sphinxcontrib.jquery` to the `extensions` list in `conf.py`, or call
`app.setup_extension("sphinxcontrib.jquery")` if you develop a Sphinx theme
or extension.
The second option is to manually ensure that the frameworks are present.
To re-add jQuery and underscore.js, you will need to copy `jquery.js` and
`underscore.js` from `the Sphinx repository`\_ to your `static` directory,
and add the following to your `layout.html`:
.. code-block:: html+jinja
{%- block scripts %} <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script> <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
{{ super() }}
{%- endblock %}
.. \_sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
Patch by Adam Turner.
- [#​10471](https://togithub.com/sphinx-doc/sphinx/issues/10471), [#​10565](https://togithub.com/sphinx-doc/sphinx/issues/10565): Removed deprecated APIs scheduled for removal in Sphinx 6.0. See
:ref:`dev-deprecated-apis` for details. Patch by Adam Turner.
- [#​10901](https://togithub.com/sphinx-doc/sphinx/issues/10901): C Domain: Remove support for parsing pre-v3 style type directives and
roles. Also remove associated configuration variables `c_allow_pre_v3` and
`c_warn_on_allowed_pre_v3`. Patch by Adam Turner.
## Features added
- [#​10924](https://togithub.com/sphinx-doc/sphinx/issues/10924): LaTeX: adopt better looking defaults for tables and code-blocks.
See :confval:`latex_table_style` and the `pre_border-radius` and
`pre_background-TeXcolor` :ref:`additionalcss` for the former defaults
and how to re-enact them if desired.
## Bugs fixed
- [#​10984](https://togithub.com/sphinx-doc/sphinx/issues/10984): LaTeX: Document :confval:`latex_additional_files` behavior for files
with `.tex` extension.
</details>
---
### Configuration
📅 **Schedule**: Branch creation - "every weekend" in timezone Etc/UTC, Automerge - "after 1 am and before 7 am" 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://app.renovatebot.com/dashboard#github/canonical/starbase).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMTYuMSIsInVwZGF0ZWRJblZlciI6IjM0LjExNi4xIn0=-->
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Closed without merging because sphinx-design did not support Sphinx 6. Renovate will ignore future 6.x updates for this repository until the blocker is resolved or the dependency is manually upgraded. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without merging because sphinx-design does not support Sphinx 6. The update was abandoned pending upstream compatibility, and Renovate will ignore future 6.x releases. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #17 chore(deps): update dependency sphinx to v6 | craft-archives | closed | Rejected without merging because sphinx-design does not support Sphinx 6. The maintainer closed the PR to block the dependency update until compatibility is resolved. | |
| #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. | |
| #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. | |
| #60 chore(deps): update dependency docs/sphinx-design to v0.4.1 | starbase | merged | Merged dependency update PR generated by Renovate bot. Updates docs/sphinx-design from v0.3.0 to v0.4.1. Approved by one reviewer, passed CI checks, and successfully merged. | |
| #873 build(deps): update dependency sphinx to v8 (main) | craft-parts | closed | Closed without merging. The Sphinx v8 update was abandoned, causing Renovate to ignore all future 8.x dependency updates until manually upgraded or the PR is renamed. | |
| #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. | |
| #112 chore(deps): update documentation dependencies to v0.8.1 | craft-store | merged | Merged an automated Renovate update that upgraded sphinx-lint from v0.6.8 to v0.8.1. The change was approved, passed CI, and modified two files with minimal diff. | |
| #1344 chore(deps): update dependency mypy to v1.6.1 | charmcraft | closed | Abandoned without merging. The mypy dependency update to v1.6.1 was approved and passed CI but manually closed. Renovate will ignore this version and open a replacement PR for newer releases. | |
| #205 chore(deps): update dependency sphinx-lint to v0.9.0 | craft-cli | merged | Merged automated dependency update for sphinx-lint from v0.8.1 to v0.9.0 via Renovate. Approved by two reviewers, passed CI, and maintained code coverage. | |
| #194 build(deps): update dependency sphinx-sitemap to ~=2.7.2 | imagecraft | closed | Closed without merging. Maintainers noted sphinx-sitemap is intentionally pinned to 2.6 due to an upstream compatibility issue. Renovate will ignore this update and await a newer version. |