Skip to content

Bump sphinx-toolbox 3.8.0 -> 4.1.2 and sphinx-tabs 3.4.7 -> 3.4.5#733

Merged
waltsims merged 2 commits into
masterfrom
chore/bump-sphinx-toolbox-and-tabs
May 16, 2026
Merged

Bump sphinx-toolbox 3.8.0 -> 4.1.2 and sphinx-tabs 3.4.7 -> 3.4.5#733
waltsims merged 2 commits into
masterfrom
chore/bump-sphinx-toolbox-and-tabs

Conversation

@waltsims
Copy link
Copy Markdown
Owner

@waltsims waltsims commented May 16, 2026

Summary

  • Bumps sphinx-toolbox from 3.8.0 to 4.1.2 and sphinx-tabs from 3.4.7 to 3.4.5.
  • sphinx-toolbox 4.1.2 strictly requires sphinx-tabs<3.4.7, so tabs is pinned to 3.4.5 (the highest version that satisfies the constraint). Going to tabs 3.5.0 (what dependabot wanted in Bump sphinx-tabs from 3.4.7 to 3.5.0 #721) would require sphinx-toolbox 4.2.0rc1, a pre-release — not worth shipping in the docs extras for now.
  • The sphinx<9 pin from Pin sphinx<9 in docs extras to fix Read the Docs build #714 is kept: I verified sphinx-toolbox 4.1.2 still does from sphinx.ext.autodoc import logger, which Sphinx 9 removed (ImportError: cannot import name 'logger' from 'sphinx.ext.autodoc').

Supersedes:

Test plan

  • uv sync --extra docs resolves cleanly with the new pins
  • sphinx-build -b html docs/ succeeds locally (134 pre-existing warnings, build succeeds)
  • CI matrix green (tests + linkChecker + ruff + docs/readthedocs)

🤖 Generated with Claude Code

Greptile Summary

Bumps sphinx-toolbox from 3.8.0 to 4.1.2 and intentionally downgrades sphinx-tabs from 3.4.7 to 3.4.5 to satisfy sphinx-toolbox 4.1.2's strict sphinx-tabs<3.4.7 constraint. The sphinx<9 pin is preserved because sphinx-toolbox 4.1.2 still imports logger from sphinx.ext.autodoc, which Sphinx 9 removed.

  • pyproject.toml updates both docs-extra pins with the correct compatible versions.
  • uv.lock is regenerated and consistent with the new constraints in pyproject.toml.

Confidence Score: 5/5

This PR is safe to merge — it touches only documentation build dependencies with no impact on the library's runtime behaviour.

The change is limited to two version pins in the docs optional-dependency group. The downgrade of sphinx-tabs and the preserved sphinx<9 upper bound are both correctly motivated by real upstream constraints that the author verified. The uv.lock is fully consistent with the updated pyproject.toml pins.

No files require special attention.

Important Files Changed

Filename Overview
pyproject.toml Updates sphinx-tabs (3.4.7→3.4.5) and sphinx-toolbox (3.8.0→4.1.2) in the docs extra; change is intentional and well-justified in the PR description.
uv.lock Lock file regenerated to reflect new sphinx-tabs and sphinx-toolbox versions; metadata markers in lock are consistent with pyproject.toml pins.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["sphinx-toolbox==4.1.2"] -->|"requires sphinx-tabs < 3.4.7"| B["sphinx-tabs==3.4.5 ✓"]
    A -->|"imports logger from sphinx.ext.autodoc\n(removed in Sphinx 9)"| C["sphinx < 9 pin kept ✓"]
    B --> D["docs build succeeds"]
    C --> D
    E["sphinx-tabs==3.4.5\n(was 3.4.7 — downgrade)"] --> B
    F["sphinx-toolbox==4.1.2\n(was 3.8.0 — upgrade)"] --> A
Loading

Reviews (2): Last reviewed commit: "Merge branch 'master' into chore/bump-sp..." | Re-trigger Greptile

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>
@codecov
Copy link
Copy Markdown

codecov Bot commented May 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.04%. Comparing base (966dfdc) to head (359e8a8).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #733   +/-   ##
=======================================
  Coverage   75.04%   75.04%           
=======================================
  Files          56       56           
  Lines        8107     8107           
  Branches     1580     1580           
=======================================
  Hits         6084     6084           
  Misses       1404     1404           
  Partials      619      619           
Flag Coverage Δ
3.10 75.02% <ø> (ø)
3.11 75.02% <ø> (ø)
3.12 75.02% <ø> (ø)
3.13 75.02% <ø> (ø)
macos-latest 74.97% <ø> (ø)
ubuntu-latest 74.97% <ø> (ø)
windows-latest 74.91% <ø> (ø)

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 waltsims merged commit 2ed2ea9 into master May 16, 2026
66 of 67 checks passed
@waltsims waltsims deleted the chore/bump-sphinx-toolbox-and-tabs branch May 16, 2026 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant