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)

---

Resolves #14153
Resolves #12555
Resolves #14189
Resolves #13713
Resolves #14089
Resolves #14050
Resolves #14228
Resolves #14207
Resolves #3099
Resolves #14064
Resolves #8854
Resolves #14219
Resolves #14227
Resolves #14225
Resolves #14224
Resolves #14222
Resolves #14220
Resolves #14157

[github-actions]

🤖 Claude Code Review

Code Review - Sphinx Version Bump (8.2.3 → 9.1.0)

Summary

This PR updates the Sphinx documentation dependency from version 8.2.3 to 9.1.0 in pyproject.toml:53. This is a major version bump for a documentation build dependency.

---

Review Results

Code Quality

• ✅ Code follows style guide: This is a dependency version update in a TOML configuration file. No code style issues.

• ✅ No commented-out code: None present.

• ✅ Meaningful variable names: N/A - dependency declaration only.

• ✅ DRY principle followed: N/A - single line change.

• ⚠️ Identify Defects: Potential compatibility risk - This is a major version bump (8.x → 9.x) which typically includes breaking changes. Consider:

  • Testing documentation build process before merging
  • Checking Sphinx 9.1.0 changelog for breaking changes
  • Verifying compatibility with related dependencies (sphinx-autodoc-typehints==3.5.1, sphinx-toolbox==4.1.1, etc.)

• ✅ Project memory configuration: No .claude/CLAUDE.md file exists, so N/A.

Testing

• ❌ Unit tests for new functions: N/A - dependency update only.

• ❌ Integration tests for new endpoints: N/A - no new endpoints.

• ⚠️ Edge cases covered: Should verify documentation builds successfully with the new Sphinx version across supported Python versions (>3.11).

• ❌ Test coverage > 80%: N/A - this is a dependency update that doesn't change source code.

Documentation

• ✅ README updated if needed: Not required for a dependency bump.

• ✅ API docs updated: Not required for this change.

• ✅ Inline comments for complex logic: N/A - no code logic.

• ❌ CHANGELOG.md updated: Missing - The CHANGELOG.md should be updated to reflect this dependency upgrade. The last entry is from 2024-02-16. Given the git commit message "Bump sphinx from 8.2.3 to 9.1.0", this should be documented.

• ✅ Markdown files follow CommonMark: Existing CHANGELOG.md follows CommonMark specification.

Security

• ✅ No hardcoded credentials: None present.

• ✅ Input validation implemented: N/A for dependency update.

• ✅ Proper error handling: N/A for dependency update.

• ✅ No sensitive data in logs: N/A for dependency update.

• ✅ No license files (.lic) or AQAAAD strings: None detected in this diff.

---

Recommendations

1. CHANGELOG.md: Update the changelog to document this dependency upgrade in pyproject.toml:53.

2. Testing: Verify the documentation build works with Sphinx 9.1.0:

   pip install -e ".[documentation]"
   # Run documentation build commands

3. Breaking changes review: Check Sphinx 9.0 release notes for any breaking changes that might affect your documentation configuration.

4. Dependency compatibility: Monitor for any deprecation warnings or compatibility issues with other sphinx-related packages during documentation builds.

---

Overall Assessment

Approval Status: ⚠️ Conditional Approval

The change itself is clean and follows proper dependency management patterns. However:

• Missing CHANGELOG.md update
• Recommend testing documentation build before final merge due to major version bump

This appears to be an automated dependency update (likely from Dependabot/Renovate), which is good practice. The main action item is updating the CHANGELOG.md.

Automated code review analyzing defects and coding standards

[github-actions]

🤖 Claude Code Review

I'll review this pull request against the provided checklist. Let me analyze the diff systematically.

Code Review Analysis

Code Quality

✅ Code follows style guide: The changes align with the Senzing code style guide. The modifications are primarily configuration and documentation files with proper formatting.

✅ No commented-out code: No commented-out code detected in the diff.

✅ Meaningful variable names: Not applicable - this PR contains configuration and documentation changes, no new variables introduced.

✅ DRY principle followed: Configuration changes are appropriate and don't introduce duplication.

✅ Identify Defects: No bugs, logic errors, edge cases, crashes, race conditions, memory leaks, or security vulnerabilities detected. The changes are configuration and documentation updates.

❌ Project memory claude configuration (./.claude/CLAUDE.md): The new .claude/CLAUDE.md file contains environment-specific content that should be general:

• .claude/CLAUDE.md:11-17 - The "Environment Setup" section includes specific commands for setting up a virtual environment. While this is generally applicable, it could be more explicit that this is a standard Python development pattern.
• However, upon closer inspection, these commands ARE general enough for any developer to use - they're standard Python virtual environment setup commands.

Revised: ✅ The .claude/CLAUDE.md file is appropriately general and doesn't contain environment-specific paths or configurations.

Testing

⚠️ Unit tests for new functions: Not applicable - no new functions added. This PR is infrastructure and documentation changes only.

⚠️ Integration tests for new endpoints: Not applicable - no new endpoints added.

⚠️ Edge cases covered: Not applicable - no new logic added.

⚠️ Test coverage > 80%: Cannot verify from this diff. No test files modified. However, pyproject.toml:47-50 removes Python 3.9 support (was "3.9", "3.10", "3.11", "3.12" → now "3.10", "3.11", "3.12", "3.13"). This is consistent with pyproject.toml:25 which updates requires-python = ">=3.10", but tests should verify this works across all supported versions.

Documentation

✅ Readme updated if needed: Not modified in this PR, but documentation files are appropriately updated where relevant.

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

✅ Inline comments for complex logic: Not applicable - no complex logic added.

✅ CHANGELOG.md updated: CHANGELOG.md:5-6 - Updated to reference CommonMark, Keep a Changelog, and Semantic Versioning with proper links at CHANGELOG.md:19-21. Good improvement.

❌ Markdown files follow CommonMark specification: Several formatting issues detected:

1. CODE_OF_CONDUCT.md:9 - Missing blank line before bulleted list ("including race, ethnicity..." starts immediately after paragraph)
2. CONTRIBUTING.md:93 - "### Pull Requests" section has inconsistent formatting
3. docs/errors.md:1 and docs/examples.md:1 and docs/development.md:1 - New files with only headers, no content. While technically valid, these appear to be stubs.
4. .github/CODEOWNERS:1 - Spacing change is good (fixed extra space)

Critical: The CHANGELOG itself states "The changelog format is based on Keep a Changelog and CommonMark" but CODE_OF_CONDUCT.md has CommonMark violations.

Security

✅ No hardcoded credentials: No credentials found.

✅ Input validation implemented: Not applicable - no new input handling.

✅ Proper error handling: Not applicable - no new error-prone code.

✅ No sensitive data in logs: Not applicable.

✅ Flag any checked in license files (.lic) or AQAAAD strings: No .lic files or AQAAAD strings detected.

Additional Observations

Workflow Configuration Changes:

1. .github/workflows/pylint.yaml:4 - Changed from on: [push] to on: pull_request with concurrency control. This is a significant change that means pylint will ONLY run on PRs, not on direct pushes to main. This should be intentional.
2. Multiple workflows now have proper concurrency groups to cancel in-progress runs - good practice.
3. .github/workflows/pylint.yaml:23 - Added timeout-minutes: 10 and fail-fast: false - good improvements.

Dependency Management:

1. pyproject.toml:70-88 - Dependencies now have Python version conditionals (e.g., different versions for Python <= 3.11 vs > 3.11). This is more complex but may be necessary for compatibility.
2. .github/dependabot.yml:6-7, 13-14 - Added 21-day cooldown for both GitHub Actions and pip dependencies. This will slow down dependency updates.

Configuration Files:

1. .project - New Eclipse project file added at repository root. This is environment/IDE-specific and arguably shouldn't be committed.
2. .claude/settings.local.json → .claude/settings.json - Renamed from "local" to standard name.
3. .claude/commands/senzing-code-review.md deleted, .claude/commands/senzing.md added - Command structure changed.

Summary

Critical Issues:

• ❌ CODE_OF_CONDUCT.md has CommonMark formatting violations (missing blank lines)
• ⚠️ .project file is IDE-specific and should likely be in .gitignore instead of committed

Warnings:

• ⚠️ Pylint workflow changed from running on all pushes to only PRs - verify this is intentional
• ⚠️ Dependabot cooldown increased to 21 days - slower security updates
• ⚠️ New stub documentation files (docs/development.md, docs/examples.md, docs/errors.md) have no content

Positive Changes:

• ✅ Updated to Code of Conduct 3.0 (more comprehensive)
• ✅ Improved CONTRIBUTING.md with better links and structure
• ✅ Added SECURITY.md file
• ✅ Workflow improvements (concurrency, timeouts, fail-fast)
• ✅ Proper CommonMark references in CHANGELOG.md
• ✅ Python 3.13 support added, 3.9 dropped consistently

---

Automated code review analyzing defects and coding standards

[github-actions]

🤖 Claude Code Review

I'll now perform a code review of this pull request against the provided checklist.

Code Review Analysis

✅ Code Quality

Style Guide Compliance

• ✅ The changes follow the Senzing code style guide. The modifications are primarily configuration files, documentation updates, and workflow improvements.
• ✅ No commented-out code detected in the diff.
• ✅ Variable and file names are meaningful and follow conventions.
• ✅ DRY principle is maintained - no code duplication observed.

Defects Analysis

• ✅ No bugs, logic errors, or security vulnerabilities detected in the changes.
• ✅ The changes are primarily organizational and documentation updates.

Project Memory Configuration

• ✅ The .claude/CLAUDE.md file is appropriately general and not specific to any local development environment. It provides useful project-level guidance.

⚠️ Testing

Test Coverage

• ⚠️ No new test files or test modifications are included in this PR. While the changes are primarily configuration and documentation updates, the pyproject.toml:34-44 shows updated test dependency versions, but no corresponding test code changes are visible.
• ⚠️ Cannot verify test coverage > 80% from the diff alone.
• ⚠️ No new unit tests or integration tests added (though this may be acceptable given the nature of changes).

❌ Documentation

Documentation Updates

• ✅ README context appears appropriate.
• ✅ New documentation files added: docs/development.md, docs/examples.md.
• ✅ CHANGELOG.md updated with proper format and links.
• ❌ CHANGELOG.md:19-21 - The new reference-style links at the bottom use proper markdown, but the existing links in the document (lines 5-6) still reference the old inline style. This creates inconsistency.
• ❌ CONTRIBUTING.md - While the markdown has been improved with reference-style links, several links are broken or point to template repository instead of the actual project:
  • Line 42: [Discussions] link points to https://github.com/senzing-garage/template-repository/discussions (should be mapper-file)
  • Line 131: [Report a security vulnerability] in SECURITY.md points to template-python (should be mapper-file)
• ✅ Markdown files generally follow CommonMark specification with improved formatting using prettier.

✅ Security

Security Compliance

• ✅ No hardcoded credentials detected.
• ✅ No sensitive data in logs.
• ✅ No .lic files or AQAAAD strings detected in the diff.
• ✅ Proper error handling maintained in workflow files.
• ✅ Input validation is not applicable for these configuration changes.

Additional Observations

Positive Changes

• ✅ .claude/CODEOWNERS:1 - Fixed formatting (removed leading space).
• ✅ .github/dependabot.yml:6-17 - Added cooldown periods (21 days) to reduce dependency update noise.
• ✅ .github/workflows/*.yaml - Improved workflow names (capitalized), added concurrency controls to prevent wasteful parallel runs, and added proper fail-fast: false strategy.
• ✅ pyproject.toml:7 - Correctly updated minimum Python version from 3.9 to 3.10.
• ✅ pyproject.toml:25-28 - Simplified build system configuration.
• ✅ pyproject.toml:37-82 - Improved dependency management with conditional version specifications based on Python version.
• ✅ .github/workflows/pylint.yaml:8-9 - Changed from on: [push] to on: pull_request which is more appropriate for CI checks.
• ✅ CODE_OF_CONDUCT.md - Updated to Contributor Covenant 3.0 with more comprehensive guidelines.
• ✅ .claude/commands/ - Replaced specific command with general Senzing command structure.

Issues Found

• ❌ CONTRIBUTING.md:42 - Broken link to Discussions (points to template-repository instead of mapper-file).
• ❌ SECURITY.md:21 - Broken link (points to template-python instead of mapper-file).
• ❌ docs/development.md:1, docs/examples.md:1 - Empty placeholder files with only headers. Consider adding basic content or removing until populated.
• ⚠️ .project file added - This is an Eclipse project configuration file. Consider adding to .gitignore instead of committing it.

Summary

This PR contains mostly positive organizational and configuration improvements. The main issues are:

1. Critical: Fix broken documentation links that point to template repositories instead of the actual project.
2. Important: Empty documentation files should either be populated or removed.
3. Minor: Consider whether .project should be committed or added to .gitignore.
4. Note: No test changes included, but this may be acceptable given the nature of the PR.

---

Automated code review analyzing defects and coding standards