chore(deps): update sphinx-toolbox requirement from <4,>=3.9.0 to >=3.9.0,<5 #200

dependabot · 2025-10-23T01:27:33Z

Updates the requirements on sphinx-toolbox to permit the latest version.

Release notes

Sourced from sphinx-toolbox's releases.

Version 4.0.0

Automatically copied from PyPI.

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

Changelog

Sourced from sphinx-toolbox's 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.

3.8.0

Improved support for Sphinx 7.3+

3.7.0

Add :class:sphinx_toolbox.more_autodoc.variables.PropertyDocumenter.

Use sphinx's HTML5Translator over HTMLTranslator.

3.6.0

Documentation fixes in :mod:~.collapse.

Dunder methods added in Python 3.13 are hidden by :mod:~.autoprotocol (__non_callable_proto_members__, __firstlineno__, __replace__, __static_attributes__)

mod:~.autoprotocol doesn't document subclasses of protocols, unless :class:~.Protocol is one of their direct base classes.

Support for Sphinx 7.x

3.5.0

Increase minimum cachecontrol version to 0.13.0

Private base classes are hidden with :rst:dir:autotypeddict

... (truncated)

Commits

d1750cf Bump version v3.10.0 -> v4.0.0
d66f7ad Update warningsfilter for newer click pending new consolekit.
adf42cc Updated files with 'repo_helper'. (#186)
c9ad057 Don't enable the sphinx_toolbox.github extension as part of the ``source`...
e7f4d29 Bump version v3.9.0 -> v3.10.0
36afdac Allow GitHub branch to be specified for installation directive. (#185)
f3ae504 Add changelog entries for past few versions.
dac4261 Updated files with 'repo_helper'. (#183)
b2013dd Update tests for installation directive.
c15ca3c Fix installation tabs in HTML when not under "Installation" heading.
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Updates the requirements on [sphinx-toolbox](https://github.com/sphinx-toolbox/sphinx-toolbox) to permit the latest version. - [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.9.0...v4.0.0) --- updated-dependencies: - dependency-name: sphinx-toolbox dependency-version: 4.0.0 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]>

github-actions · 2025-10-23T01:28:33Z

Claude encountered an error —— View job

I'll analyze this and get back to you.

…lt-5

github-actions · 2025-10-26T20:39:56Z

Claude finished @dependabot[bot]'s task —— View job

✅ PR Review Complete: sphinx-toolbox dependency update

This Dependabot PR updates the sphinx-toolbox dependency constraint from <4 to <5, allowing version 4.x releases. All checks pass successfully.

📋 Review Summary

✅ Passing Checks

Breaking Change Analysis ✅
- sphinx-toolbox 4.0.0 breaking change does NOT affect this project
- The project explicitly enables sphinx_toolbox.github extension in docs/source/conf.py:9
- Breaking change only impacts projects relying on auto-enable behavior from sphinx_toolbox.source
Documentation Build ✅
- HTML and singlehtml documentation build successfully
- Currently using sphinx-toolbox 3.10.0 (within new allowed range >=3.9.0,<5)
- 43 warnings present (pre-existing, unrelated to this update)
Linting ✅
- All linting checks pass: ruff format, ruff check, pyright, mypy
- No new issues introduced
Commit Messages ✅
- Proper conventional commit format: chore(deps): ...
- Includes detailed commit body with dependency information
- Signed-off by Dependabot

📦 Change Details

File: pyproject.toml (line 184)

- "sphinx-toolbox>=3.9.0,<4",
+ "sphinx-toolbox>=3.9.0,<5",

Impact: Allows sphinx-toolbox versions 4.0.0 through 4.x.x

🔍 Technical Analysis

sphinx-toolbox Changelog Review:

Version	Notable Changes
4.0.0	Breaking: `sphinx_toolbox.source` no longer auto-enables `sphinx_toolbox.github`
3.10.0	Allow GitHub branch specification for installation directive
3.9.0	Improved support for Sphinx 8.1+

Why This PR is Safe:

The project's Sphinx configuration (docs/source/conf.py) explicitly declares both extensions:

extensions = [
    "sphinx_toolbox.collapse",
    "sphinx_toolbox.sidebar_links",
    "sphinx_toolbox.github",        # ← Explicitly enabled
    "sphinx_toolbox.source",
    # ... other extensions
]

This explicit configuration makes the project immune to the v4.0.0 breaking change.

✅ Recommendation

APPROVE & MERGE

This dependency update:

✅ Maintains backward compatibility with current setup
✅ Passes all automated checks
✅ Follows proper versioning practices
✅ Includes comprehensive release notes
✅ Has proper commit message formatting

No action required from maintainers - this is a safe, routine dependency update.

📚 References

sphinx-toolbox v4.0.0 Release Notes
sphinx-toolbox Changelog
Repository CLAUDE.md - Development standards

| Branch: dependabot/pip/sphinx-toolbox-gte-3.9.0-and-lt-5

codecov · 2025-10-26T20:55:40Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

sonarqubecloud · 2025-10-26T20:56:27Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

dependabot bot added bot Automated pull requests or issues dependabot Pull requests from Dependabot dependencies Pull requests that update a dependency file skip:test:long_running Skip long-running tests (≥5min) labels Oct 23, 2025

Merge branch 'main' into dependabot/pip/sphinx-toolbox-gte-3.9.0-and-…

0725498

…lt-5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(deps): update sphinx-toolbox requirement from <4,>=3.9.0 to >=3.9.0,<5 #200

chore(deps): update sphinx-toolbox requirement from <4,>=3.9.0 to >=3.9.0,<5 #200

Uh oh!

dependabot bot commented on behalf of github Oct 23, 2025

Uh oh!

github-actions bot commented Oct 23, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 26, 2025 •

edited

Loading

Uh oh!

codecov bot commented Oct 26, 2025 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Oct 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chore(deps): update sphinx-toolbox requirement from <4,>=3.9.0 to >=3.9.0,<5 #200

Are you sure you want to change the base?

chore(deps): update sphinx-toolbox requirement from <4,>=3.9.0 to >=3.9.0,<5 #200

Uh oh!

Conversation

dependabot bot commented on behalf of github Oct 23, 2025

Version 4.0.0

4.0.0

3.10.0

3.9.0

3.8.2

3.8.0

3.7.0

3.6.0

3.5.0

Uh oh!

github-actions bot commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ PR Review Complete: sphinx-toolbox dependency update

📋 Review Summary

✅ Passing Checks

📦 Change Details

🔍 Technical Analysis

✅ Recommendation

📚 References

Uh oh!

codecov bot commented Oct 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sonarqubecloud bot commented Oct 26, 2025

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Oct 23, 2025 •

edited

Loading

github-actions bot commented Oct 26, 2025 •

edited

Loading

codecov bot commented Oct 26, 2025 •

edited

Loading