Skip to content

Bump sphinx-toolbox from 3.8.0 to 4.1.2#700

Closed
dependabot[bot] wants to merge 1 commit into
masterfrom
dependabot/pip/sphinx-toolbox-4.1.2
Closed

Bump sphinx-toolbox from 3.8.0 to 4.1.2#700
dependabot[bot] wants to merge 1 commit into
masterfrom
dependabot/pip/sphinx-toolbox-4.1.2

Conversation

@dependabot
Copy link
Copy Markdown
Contributor

@dependabot dependabot Bot commented on behalf of github Mar 30, 2026

Bumps sphinx-toolbox from 3.8.0 to 4.1.2.

Release notes

Sourced from sphinx-toolbox's releases.

Version 4.1.2

Automatically copied from PyPI.


Powered by OctoCheese
📝 docs | :octocat: repo | 🙋 issues | 🏪 marketplace

Version 4.1.1

Automatically copied from PyPI.


Powered by OctoCheese
🎄 docs | ☃ repo | 🎅 issues | 🎁 marketplace

Version 4.1.0

Automatically copied from PyPI.


Powered by OctoCheese
🎄 docs | ☃ repo | 🎅 issues | 🎁 marketplace

Version 4.0.0

Automatically copied from PyPI.


Powered by OctoCheese
📝 docs | :octocat: repo | 🙋 issues | 🏪 marketplace

Version 3.10.0

Automatically copied from PyPI.


Powered by OctoCheese
📝 docs | :octocat: repo | 🙋 issues | 🏪 marketplace

... (truncated)

Changelog

Sourced from sphinx-toolbox's changelog.

=============== Changelog

4.0.0

The :mod:sphinx_toolbox.source module no longer enables the :mod:sphinx_toolbox.github extension automatically. If you have :confval:source_link_target set to 'GitHub' you may need to enable the extension manually.

3.10.0

Allow GitHub branch to be specified for :rst:dir:installation directive.

3.9.0

Improved support for Sphinx 8.1+

3.8.2

(BUG) Fix GitHub issue title parsing.

Commits

Greptile Summary

This PR bumps the sphinx-toolbox documentation dependency from 3.8.0 to 4.1.2. The v4.0.0 changelog notes one breaking change — sphinx_toolbox.source no longer auto-enables sphinx_toolbox.github — but docs/conf.py only uses sphinx_toolbox.code and sets no source_link_target, so the project is unaffected.

  • pyproject.toml: version pin for sphinx-toolbox updated from 3.8.0 to 4.1.2 in the [project.optional-dependencies] docs group.
  • No application code, tests, or other configuration files are changed.

Confidence Score: 5/5

Safe to merge — only a docs-toolchain dependency is updated, and the one breaking change introduced in v4.0.0 does not apply to this project's Sphinx configuration.

The sole change is a version pin for a documentation build tool. The v4.0.0 breaking change (manual registration of sphinx_toolbox.github when using source_link_target='GitHub') was verified not to affect this project: docs/conf.py loads sphinx_toolbox.code only and never sets source_link_target.

No files require special attention.

Important Files Changed

Filename Overview
pyproject.toml Bumps sphinx-toolbox from 3.8.0 to 4.1.2 in the docs extras; no breaking changes affect this project since sphinx_toolbox.source / source_link_target='GitHub' are not used.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[pyproject.toml\ndocs extras] -->|was 3.8.0| B[sphinx-toolbox 3.8.0]
    A -->|now 4.1.2| C[sphinx-toolbox 4.1.2]

    C --> D{Breaking change\nin v4.0.0?}
    D -->|sphinx_toolbox.source\nno longer auto-enables\nsphinx_toolbox.github| E[Check docs/conf.py]
    E -->|Only sphinx_toolbox.code\nis loaded\nNo source_link_target set| F[Not affected ✅]
Loading

Reviews (4): Last reviewed commit: "Bump sphinx-toolbox from 3.8.0 to 4.1.2" | Re-trigger Greptile

@dependabot dependabot Bot added dependencies Pull requests that update a dependency file python Pull requests that update python code labels Mar 30, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.82%. Comparing base (9f25de1) to head (c915977).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #700   +/-   ##
=======================================
  Coverage   74.82%   74.82%           
=======================================
  Files          56       56           
  Lines        8095     8095           
  Branches     1577     1577           
=======================================
  Hits         6057     6057           
  Misses       1422     1422           
  Partials      616      616           
Flag Coverage Δ
3.10 74.79% <ø> (ø)
3.11 74.79% <ø> (ø)
3.12 74.79% <ø> (ø)
3.13 74.79% <ø> (ø)
macos-latest 74.74% <ø> (ø)
ubuntu-latest 74.74% <ø> (ø)
windows-latest 74.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@waltsims
Copy link
Copy Markdown
Owner

@dependabot rebase

@dependabot @github
Copy link
Copy Markdown
Contributor Author

dependabot Bot commented on behalf of github May 16, 2026

Looks like this PR has been edited by someone other than Dependabot. That means Dependabot can't rebase it - sorry!

If you're happy for Dependabot to recreate it from scratch, overwriting any edits, you can request @dependabot recreate.

@waltsims
Copy link
Copy Markdown
Owner

@copilot resolve the merge conflicts in this pull request

Copy link
Copy Markdown
Contributor

Copilot AI commented May 16, 2026

@copilot resolve the merge conflicts in this pull request

Resolved and pushed in commit 17212b6. I merged origin/master into this PR branch and fixed the pyproject.toml/uv.lock merge conflicts so the PR is mergeable again.

Copilot AI requested a review from waltsims May 16, 2026 16:22
@waltsims
Copy link
Copy Markdown
Owner

@dependabot recreate

Bumps [sphinx-toolbox](https://github.com/sphinx-toolbox/sphinx-toolbox) from 3.8.0 to 4.1.2.
- [Release notes](https://github.com/sphinx-toolbox/sphinx-toolbox/releases)
- [Changelog](https://github.com/sphinx-toolbox/sphinx-toolbox/blob/master/doc-source/changelog.rst)
- [Commits](sphinx-toolbox/sphinx-toolbox@v3.8.0...v4.1.2)

---
updated-dependencies:
- dependency-name: sphinx-toolbox
  dependency-version: 4.1.2
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot Bot force-pushed the dependabot/pip/sphinx-toolbox-4.1.2 branch from 17212b6 to c915977 Compare May 16, 2026 16:29
@waltsims
Copy link
Copy Markdown
Owner

Superseded by #733, which bumps sphinx-toolbox to 4.1.2 plus the required tabs downgrade in a single hand-rolled PR with verified docs build.

@waltsims waltsims closed this May 16, 2026
@dependabot @github
Copy link
Copy Markdown
Contributor Author

dependabot Bot commented on behalf of github May 16, 2026

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@dependabot dependabot Bot deleted the dependabot/pip/sphinx-toolbox-4.1.2 branch May 16, 2026 16:43
waltsims added a commit that referenced this pull request May 16, 2026
sphinx-toolbox 4.1.2 requires sphinx-tabs<3.4.7, so tabs is pinned
to 3.4.5 (the highest version satisfying that constraint).

The sphinx<9 pin from #714 is kept: sphinx-toolbox 4.1.2 still does
`from sphinx.ext.autodoc import logger`, which Sphinx 9 removed.

Supersedes #700 (toolbox bump) and #721 (tabs bump to 3.5.0, which
cannot coexist with the toolbox 4.1.2 constraint).

Verified locally: `uv sync --extra docs` resolves cleanly and
`sphinx-build -b html docs/` completes successfully.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file python Pull requests that update python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants