Skip to content

Split docs deps and upgrade Sphinx to 9.1.0#2843

Merged
pvcraven merged 5 commits intodevelopmentfrom
update-sphinx-9.1.0
Apr 20, 2026
Merged

Split docs deps and upgrade Sphinx to 9.1.0#2843
pvcraven merged 5 commits intodevelopmentfrom
update-sphinx-9.1.0

Conversation

@pvcraven
Copy link
Copy Markdown
Member

Summary

  • Splits doc-building dependencies into a separate docs dependency group
  • Upgrades Sphinx from 8.1.3 to 9.1.0 and sphinx-rtd-theme from 3.0.2 to 3.1.0
  • Test CI uses uv sync --no-group docs to avoid installing Sphinx on Python 3.10/3.11 (Sphinx 9.x requires Python >=3.12)
  • Code quality / doc build CI continues to use uv sync which installs all groups
  • Local dev (uv sync) still gets everything since dev includes docs via include-group

Test plan

  • CI passes on Python 3.10, 3.11 (no Sphinx installed)
  • CI passes on Python 3.12+ (Sphinx installed)
  • Doc build succeeds in code_quality workflow

🤖 Generated with Claude Code

Paul V Craven and others added 5 commits April 20, 2026 13:20
Sphinx 9.x requires Python >=3.12, but arcade supports >=3.10. Move
all doc-building deps into a 'docs' dependency group so test CI can
skip them on Python 3.10/3.11 via 'uv sync --no-group docs'.

Also upgrades sphinx-rtd-theme from 3.0.2 to 3.1.0 (required for
Sphinx 9.x compatibility).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
RTD was using pip with extra_requirements, but deps are in
[dependency-groups] not [project.optional-dependencies], so
RTD never actually installed Sphinx. Switch to RTD's native
uv support with 'command: sync' and 'groups: [docs]'.

Also bump RTD from Python 3.10 to 3.13 and Ubuntu 24.04
(Sphinx 9.x requires Python >=3.12).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
uv does universal resolution across all versions in requires-python
(>=3.10), so Sphinx 9.1.0 fails even on Python 3.13. Fix by:

- Adding 'python_version >= 3.12' markers to all docs group deps
- Removing docs include from dev group (keep them independent)
- Code quality CI uses 'uv sync --group docs' explicitly
- RTD installs both dev and docs groups

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- pygments 2.19.1 → 2.20.0
- sphinx-togglebutton 0.3.2 → 0.4.5
- sphinx-sitemap 2.6.0 → 2.9.0
- sphinx-autobuild 2024.10.3 → 2025.8.25
- docutils 0.21.2 → 0.22.4

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The ':type: tuple (x, y, width, height)' syntax caused Sphinx to
interpret x and y as cross-references to class attributes. Use
inline code markup instead.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@pvcraven pvcraven merged commit cf30fbb into development Apr 20, 2026
7 checks passed
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