Bump sphinx from 8.2.3 to 9.1.0

[dependabot]

Bumps sphinx from 8.2.3 to 9.1.0.

Release notes

Sourced from sphinx's releases.

Sphinx 9.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Dependencies

• #14153: Drop Python 3.11 support.
• #12555: Drop Docutils 0.20 support. Patch by Adam Turner

Features added

• Add add_static_dir() for copying static assets from extensions to the build output. Patch by Jared Dillard

Bugs fixed

• #14189: autodoc: Fix duplicate :no-index-entry: for modules. Patch by Adam Turner
• #13713: Fix compatibility with MyST-Parser. Patch by Adam Turner
• Fix tests for Python 3.15. Patch by Adam Turner
• #14089: autodoc: Fix default option parsing. Patch by Adam Turner
• Remove incorrect static typing assertions. Patch by Adam Turner
• #14050: LaTeXTranslator fails to build documents using the "acronym" standard role. Patch by Günter Milde
• LaTeX: Fix rendering for grid filled merged vertical cell. Patch by Tim Nordell
• #14228: LaTeX: Fix overrun footer for cases of merged vertical table cells. Patch by Tim Nordell
• #14207: Fix creating HTMLThemeFactory objects in third-party extensions. Patch by Adam Turner
• #3099: LaTeX: PDF build crashes if a code-block contains more than circa 1350 codelines (about 27 a4-sized pages at default pointsize). Patch by Jean-François B.
• #14064: LaTeX: TABs ending up in sphinxVerbatim fail to obey tab stops. Patch by Jean-François B.
• #14089: autodoc: Improve support for non-weakreferencable objects. Patch by Adam Turner
• LaTeX: Fix accidental removal at 3.5.0 (#8854) of the documentation of literalblockcappos key of sphinxsetup. Patch by Jean-François B.

... (truncated)

Changelog

Sourced from sphinx's changelog.

Release 9.1.0 (released Dec 31, 2025)

Dependencies

• #14153: Drop Python 3.11 support.
• #12555: Drop Docutils 0.20 support. Patch by Adam Turner

Features added

• Add :meth:~sphinx.application.Sphinx.add_static_dir for copying static assets from extensions to the build output. Patch by Jared Dillard

Bugs fixed

• #14189: autodoc: Fix duplicate :no-index-entry: for modules. Patch by Adam Turner
• #13713: Fix compatibility with MyST-Parser. Patch by Adam Turner
• Fix tests for Python 3.15. Patch by Adam Turner
• #14089: autodoc: Fix default option parsing. Patch by Adam Turner
• Remove incorrect static typing assertions. Patch by Adam Turner
• #14050: LaTeXTranslator fails to build documents using the "acronym" standard role. Patch by Günter Milde
• LaTeX: Fix rendering for grid filled merged vertical cell. Patch by Tim Nordell
• #14228: LaTeX: Fix overrun footer for cases of merged vertical table cells. Patch by Tim Nordell
• #14207: Fix creating HTMLThemeFactory objects in third-party extensions. Patch by Adam Turner
• #3099: LaTeX: PDF build crashes if a code-block contains more than circa 1350 codelines (about 27 a4-sized pages at default pointsize). Patch by Jean-François B.
• #14064: LaTeX: TABs ending up in sphinxVerbatim fail to obey tab stops. Patch by Jean-François B.
• #14089: autodoc: Improve support for non-weakreferencable objects. Patch by Adam Turner
• LaTeX: Fix accidental removal at 3.5.0 (#8854) of the documentation of literalblockcappos key of :ref:'sphinxsetup' <latexsphinxsetup>. Patch by Jean-François B.

Commits

• cc7c6f4 Bump to 9.1.0 final
• b127b94 Add app.add_static_dir() for copying extension static files (#14219)
• 20f1c46 LaTeX: Inhibit breaks for rows with merged vertical cells (#14227)
• 3c85411 Polish CHANGES.rst (#14225)
• 9ee5446 LaTeX: restore 1.7 documentation of literalblockcappos (#14224)
• d75d602 LaTeX: improve (again...) some code comments in time for 9.1.0 (#14222)
• 8dca61d Improve some LaTeX code comments (#14220)
• 8ab9600 Bump to 9.1.0 candidate 2
• d59b237 autodoc: Improve support for non-weakreferencable objects
• 964424b Use the correct reference for using existing extensions (#14157)
• 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)

[github-actions]

🤖 Claude Code Review

Code Review Results

Summary

This PR bumps the sphinx dependency from version 8.2.3 to 9.1.0 in the documentation dependencies. This is a minor version upgrade for a documentation-only dependency.

---

Code Quality

✅ Code follows style guide

• Status: N/A - This is a dependency version change only
• The change is in pyproject.toml which follows standard TOML formatting

✅ No commented-out code

• Status: Pass - No commented code present

✅ Meaningful variable names

• Status: N/A - No variables changed

✅ DRY principle followed

• Status: N/A - No code duplication issues

✅ Identify Defects

• Status: Pass - No bugs, logic errors, or vulnerabilities introduced
• This is a straightforward dependency version update
• The constraint python_version > '3.11' remains appropriate

⚠️ Project memory claude configuration

• Status: N/A - No .claude/CLAUDE.md file exists in the project

---

Testing

❌ Unit tests for new functions

• Status: Not Applicable, but MISSING test validation
• Issue: While this is a dependency bump, there are no tests run to verify documentation builds successfully with Sphinx 9.1.0
• Recommendation: Documentation build tests should be executed to ensure compatibility

❌ Integration tests for new endpoints

• Status: N/A - No endpoints changed

❌ Edge cases covered

• Status: Not verified - No evidence of testing edge cases with the new Sphinx version

❌ Test coverage > 80%

• Status: Not applicable for dependency changes, but no test results provided

---

Documentation

❌ Readme updated if needed

• Status: Not Required - README doesn't need updates for internal dependency changes
• Location: pyproject.toml:60

❌ API docs updated

• Status: N/A - No API changes

❌ Inline comments for complex logic

• Status: N/A - No complex logic added

❌ CHANGELOG.md updated

• Status: MISSING - Dependency updates should be documented
• Issue: The CHANGELOG.md was not updated to reflect the Sphinx version bump
• Location: CHANGELOG.md - Should add entry under [Unreleased] section
• Recommendation: Add an entry like:

  ## [Unreleased]
  
  ### Changed
  
  - Bump sphinx from 8.2.3 to 9.1.0

✅ Markdown files formatted correctly

• Status: Pass - No markdown changes in this PR

---

Security

✅ No hardcoded credentials

• Status: Pass - No credentials present

✅ Input validation implemented

• Status: N/A - No input handling changed

✅ Proper error handling

• Status: N/A - No error handling changed

✅ No sensitive data in logs

• Status: Pass - No logging changes

✅ No license files or AQAAAD strings

• Status: Pass - No license files checked in

---

Critical Issues

None - This is a low-risk dependency update for documentation tooling only.

Required Actions

1. Update CHANGELOG.md (CHANGELOG.md:8) - Add entry under [Unreleased] section documenting the Sphinx version bump
2. Verify Documentation Build - Ensure documentation builds successfully with Sphinx 9.1.0 before merging

Nice to Have

• Consider adding automated documentation build tests to CI/CD pipeline to catch breaking changes in documentation dependencies

---

Overall Assessment

Status: ⚠️ Approve with Minor Changes Required

This is a straightforward dependency update with minimal risk. The only required change is updating the CHANGELOG.md file. It would be prudent to verify that documentation builds successfully with the new Sphinx version before merging.

Automated code review analyzing defects and coding standards

[github-actions]

🤖 Claude Code Review

Code Review Analysis

Executive Summary

This PR upgrades the Sphinx documentation dependency from version 8.2.3 to 9.1.0. The change is minimal and low-risk, but requires attention to testing and documentation requirements.

---

Detailed Review

Code Quality

✅ Code follows style guide

• The change follows standard Python dependency specification format in pyproject.toml
• No code style issues detected in this configuration change

✅ No commented-out code

• No commented code present

✅ Meaningful variable names

• N/A - This is a dependency version update

✅ DRY principle followed

• N/A - Single dependency version specification

⚠️ Identify Defects

• Potential breaking changes: Sphinx 9.x is a major version upgrade from 8.x. While no immediate defects are apparent, this warrants careful testing:
  • Check for deprecated APIs that may have been removed
  • Verify documentation builds successfully with no warnings/errors
  • Review Sphinx 9.0 and 9.1 release notes for breaking changes
• No bugs, logic errors, or security vulnerabilities in the change itself

Testing

❌ Unit tests for new functions

• pyproject.toml:60 - No evidence of tests added to verify documentation build compatibility with Sphinx 9.1.0
• Required: Documentation build tests should be run to ensure the upgrade doesn't break existing documentation generation

❌ Integration tests for new endpoints

• N/A for dependency updates, but documentation build integration should be tested

❌ Edge cases covered

• Should verify documentation builds work across all supported Python versions (>3.11 per the constraint)

❌ Test coverage > 80%

• Unable to verify test coverage for this change without seeing test results
• Documentation build should be part of CI/CD verification

Documentation

❌ Readme updated if needed

• No README updates included. If the README mentions Sphinx version requirements or documentation build instructions, it should be reviewed

⚠️ API docs updated

• Cannot verify if the documentation still builds correctly with Sphinx 9.1.0
• Action required: Build and review generated documentation

✅ Inline comments for complex logic

• N/A - Dependency specification is self-explanatory

❌ CHANGELOG.md updated

• No CHANGELOG.md update detected in the diff
• Required: Should document the Sphinx version upgrade, especially for a major version bump

✅ Markdown files formatted correctly

• N/A - No markdown files modified

Security

✅ No hardcoded credentials

• No credentials present

✅ Input validation implemented

• N/A for dependency updates

✅ Proper error handling

• N/A for dependency updates

✅ No sensitive data in logs

• N/A for dependency updates

✅ No license files or AQAAAD strings

• No license files or sensitive strings detected in this change

---

Summary of Required Actions

Critical

None

Must Fix

1. CHANGELOG.md: Update to document the Sphinx 9.1.0 upgrade (pyproject.toml:60)
2. Documentation Build Testing: Verify documentation builds successfully with no errors or warnings

Should Address

1. Test Evidence: Provide evidence that documentation builds were tested with Sphinx 9.1.0
2. Release Notes Review: Confirm Sphinx 9.x breaking changes don't affect this project
3. README Review: Check if documentation build instructions need updates

Recommendations

• Consider adding automated documentation build tests to CI/CD if not already present
• Document any configuration changes needed for Sphinx 9.x compatibility
• Review and update any Sphinx-specific configuration files (e.g., conf.py) if they exist

---

Overall Assessment

Status: ⚠️ Needs Attention

The code change itself is clean and straightforward, but the major version upgrade requires proper testing and documentation updates before merging.

Automated code review analyzing defects and coding standards

[github-actions]

🤖 Claude Code Review

---

Code Review - Sphinx Version Bump (8.2.3 → 9.1.0)

Summary

This PR bumps the Sphinx documentation dependency from version 8.2.3 to 9.1.0. This is an automated dependency update (likely from Dependabot).

---

✅ Code Quality

✅ Code follows style guide

• Status: PASS
• Details: This is a dependency version change in pyproject.toml. No code style issues apply.

✅ No commented-out code

• Status: PASS
• Details: No commented code in the diff.

✅ Meaningful variable names

• Status: PASS / N/A
• Details: No variables changed.

✅ DRY principle followed

• Status: PASS / N/A
• Details: Single version bump, no duplication.

✅ Identify Defects

• Status: PASS with MINOR OBSERVATION
• Details: No defects in the change itself. However, this is a major version bump (8.x → 9.x) which may include breaking changes. Ensure documentation builds are tested.

✅ Project memory configuration

• Status: PASS
• Details: No .claude/CLAUDE.md file exists in this repository, so no project-specific configuration to consider.

---

⚠️ Testing

❌ Unit tests for new functions

• Status: N/A for dependency bump, but TESTING RECOMMENDED
• Details: No new functions added. However, major version bumps should trigger CI/CD pipeline testing of documentation builds.

❌ Integration tests for new endpoints

• Status: N/A
• Details: No new endpoints.

❌ Edge cases covered

• Status: N/A
• Details: No code logic changes.

❌ Test coverage > 80%

• Status: N/A
• Details: No testable code added. Dependency-only change.

Recommendation: Ensure the documentation build pipeline runs successfully with Sphinx 9.1.0 before merging.

---

❌ Documentation

❌ Readme updated if needed

• Status: FAIL
• Details: README.md does not require updates for internal dev dependency changes.

❌ API docs updated

• Status: N/A
• Details: No API changes.

❌ Inline comments for complex logic

• Status: N/A
• Details: No code logic added.

❌ CHANGELOG.md updated

• Status: FAIL - pyproject.toml:60
• Details: The CHANGELOG.md should be updated to reflect this dependency bump. Following the existing format:

  ## [Unreleased]
  
  ### Changed in Unreleased
  
  - Bump sphinx from 8.2.3 to 9.1.0

• File: CHANGELOG.md:8
• Action Required: Add entry under [Unreleased] section.

✅ Markdown formatting

• Status: PASS
• Details: No markdown files changed in this PR.

---

✅ Security

✅ No hardcoded credentials

• Status: PASS
• Details: No credentials in diff.

✅ Input validation implemented

• Status: N/A
• Details: No input handling added.

✅ Proper error handling

• Status: N/A
• Details: No error handling code added.

✅ No sensitive data in logs

• Status: PASS
• Details: No logging changes.

✅ No license files checked in

• Status: PASS
• Details: No .lic files or AQAAAD strings detected in the diff.

---

📋 Final Verdict

Critical Issues: 0

Issues Requiring Action: 1

❌ Action Required:

1. CHANGELOG.md - Add entry documenting the Sphinx version bump from 8.2.3 to 9.1.0 in the [Unreleased] section (CHANGELOG.md:8)

✅ Recommendations:

1. Testing - Verify documentation builds successfully with Sphinx 9.1.0 (major version change may include breaking changes)
2. CI/CD - Ensure automated tests pass before merging

---

Overall Assessment: The code change itself is clean and follows proper dependency management practices. However, the CHANGELOG.md must be updated to document this change per project standards.

Automated code review analyzing defects and coding standards

[github-actions]

🤖 Claude Code Review

I'll analyze this PR diff against the review checklist.

Code Review Analysis

Code Quality

✅ Code follows style guide: The change follows proper TOML syntax and formatting conventions.

✅ No commented-out code: None present.

✅ Meaningful variable names: Dependency name and version are clear and standard.

✅ DRY principle followed: Single version update, no duplication.

✅ Defects identification:

• POTENTIAL ISSUE ⚠️: This is a major version bump (8.2.3 → 9.1.0) for Sphinx. Major version changes typically include breaking changes.
• Concern: No corresponding updates to related Sphinx extensions (sphinx-autodoc-typehints, sphinx-gallery, sphinx-jinja2-compat, sphinx-prompt) which may have compatibility issues with Sphinx 9.x.
• Recommendation: Verify that all Sphinx plugins are compatible with Sphinx 9.1.0, particularly sphinx-autodoc-typehints==3.1.0 which may need updating.

✅ Project memory: No .claude/CLAUDE.md file found in the repository to consider.

Testing

❌ Unit tests for new functions: Not applicable - this is a dependency version bump.

❌ Integration tests for new endpoints: Not applicable.

❌ Edge cases covered: No test updates included to verify documentation build still works with Sphinx 9.1.0.

⚠️ Test coverage: Not applicable for dependency updates, but build verification is missing.

RECOMMENDATION: Should include evidence that:

• Documentation builds successfully with Sphinx 9.1.0
• All existing Sphinx extensions remain compatible
• Generated documentation renders correctly

Documentation

❌ README.md updated if needed: Not applicable - internal dependency change.

❌ API docs updated: Not applicable - no API changes.

❌ Inline comments for complex logic: Not applicable.

⚠️ CHANGELOG.md updated:

• MISSING: Dependency updates should typically be documented in CHANGELOG.md
• Location: Should add entry in pyproject.toml:57 context
• Recommendation: Add entry like "Updated Sphinx from 8.2.3 to 9.1.0"

❌ Markdown formatting: Not applicable - no markdown changes in this PR.

Security

✅ No hardcoded credentials: None present.

✅ Input validation: Not applicable.

✅ Proper error handling: Not applicable.

✅ No sensitive data in logs: Not applicable.

✅ No license files (.lic) or AQAAAD strings: None detected.

---

Summary

Status: ⚠️ NEEDS ATTENTION

Critical Issues

None - but see concerns below.

Major Concerns

1. Breaking Changes Risk: Sphinx 9.x is a major version bump that likely contains breaking changes
2. Plugin Compatibility: No verification that dependent Sphinx plugins are compatible with v9
3. Missing Testing: No evidence documentation builds successfully

Minor Issues

1. Missing CHANGELOG entry: Should document this dependency update

Recommendations

1. Before merging:

   • Verify documentation builds: python -m sphinx.cmd.build docs/ build/docs/
   • Check Sphinx 9.0 release notes for breaking changes
   • Test that all Sphinx extensions work with the new version
   • Consider updating related Sphinx plugins if needed

2. Add CHANGELOG entry documenting the Sphinx version bump

3. Consider: If this is coming from Dependabot, ensure CI/CD pipeline includes documentation build validation to catch compatibility issues automatically

Overall Assessment: The code change itself is clean and simple, but a major version bump of a documentation tool requires validation that the build pipeline still works correctly.

Automated code review analyzing defects and coding standards

[dependabot]

Looks like sphinx is no longer updatable, so this is no longer needed.