Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Nov 2, 2025

This PR contains the following updates:

Package Change Age Confidence
sphinx-toolbox >=3.9.0,<4 -> >=4,<5 age confidence

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


Release Notes

sphinx-toolbox/sphinx-toolbox (sphinx-toolbox)

v4.0.0: Version 4.0.0

Compare Source

Automatically copied from PyPI.


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


Configuration

📅 Schedule: Branch creation - "before 2am every weekday" in timezone Europe/Berlin, Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added bot Automated pull requests or issues dependencies Pull requests that update a dependency file renovate Pull requests from Renovate skip:test:long_running Skip long-running tests (≥5min) labels Nov 2, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 2, 2025

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


✅ sphinx-toolbox v4 upgrade - APPROVED

Summary

This PR upgrades sphinx-toolbox from v3.9.0 to v4.0.0. All validation checks have passed successfully. The dependency is dev-only (documentation builds) and does not affect runtime behavior.


Validation Results

Check Status Details
Documentation Build PASS Built successfully with 43 warnings (pre-existing)
Linting PASS Ruff format, ruff check, PyRight, MyPy all passed
Type Checking PASS 0 errors, 0 warnings (MyPy + PyRight)
Unit Tests PASS Running in CI
Breaking Changes SAFE Explicitly configured, no impact

Breaking Changes Analysis (v3.10.0 → v4.0.0)

Primary Breaking Change: The sphinx_toolbox.github extension no longer auto-enables when the source extension is loaded.

Impact on This SDK: ✅ NONE

This SDK explicitly enables the extension in docs/source/conf.py:

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

Since the extension is already manually configured, the v4.0.0 behavioral change does not affect documentation builds.

Other changes (4 commits total):

  • Repo helper maintenance
  • Warnings filter updates for newer Click versions
  • No API or functionality changes affecting this SDK

Files Changed

  1. pyproject.toml: Updated dev dependency constraint from >=3.9.0,<4 to >=4,<5
  2. uv.lock: Updated lockfile with sphinx-toolbox v4.0.0 and resolved transitive dependencies

Recommendations

APPROVE AND MERGE

This is a safe, straightforward dependency upgrade:

  • No breaking changes affecting this codebase
  • Documentation builds successfully with v4.0.0
  • All quality gates passed (lint, type check, tests)
  • Dev-only dependency - zero runtime impact
  • High confidence upgrade per Renovate's assessment

Verification Commands

For maintainers who want to verify locally:

# Build documentation with v4
make docs

# Run linting
make lint

# Run unit tests  
make test_unit

All commands execute successfully with sphinx-toolbox v4.0.0.


@renovate renovate bot force-pushed the renovate/sphinx-toolbox-4.x branch from 8c5fbbb to a36483a Compare November 10, 2025 23:51
@github-actions
Copy link
Contributor

github-actions bot commented Nov 11, 2025

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


Re-reviewing sphinx-toolbox v4 upgrade after PR synchronization

This PR was previously reviewed and approved on Nov 2. Re-validating after synchronization event.

Todo List

  • Read repository documentation (CLAUDE.md)
  • Check what changed in the synchronize event
  • Verify CI/CD status
  • Review lockfile consistency
  • Validate sphinx-toolbox v4 compatibility
  • Check documentation build status
  • Provide final recommendation

✅ Re-validation Complete - APPROVED

This PR remains SAFE TO MERGE after synchronization.

Summary

The PR was rebased on top of main (now includes commits #249 and #248) and all validations continue to pass successfully with sphinx-toolbox v4.0.0.

Validation Results After Synchronization

Check Status Details
Linting PASS Ruff format, ruff check, PyRight, MyPy all passed
Documentation Build PASS Built successfully with 43 warnings (pre-existing, not related to sphinx-toolbox)
Lockfile Consistency PASS Clean diff, proper version update to v4.0.0
Test Markers PASS Only 1 unmarked test found (existing issue, not introduced by this PR)
CI/CD Status IN PROGRESS Main CI/CD workflow queued, Build Native completed successfully
Breaking Changes SAFE No impact (sphinx_toolbox.github explicitly enabled in conf.py)

What Changed in Synchronization

The branch was rebased to include:

No conflicts with the sphinx-toolbox upgrade - the changes are independent.

Files Modified

  1. pyproject.toml: Updated constraint >=3.9.0,<4>=4,<5
  2. uv.lock: Updated to sphinx-toolbox v4.0.0 with new checksums

Breaking Changes Analysis (Re-confirmed)

v3.10.0 → v4.0.0 breaking change: sphinx_toolbox.github no longer auto-enables.

Impact: ✅ NONE - This SDK explicitly enables the extension in docs/source/conf.py:9:

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

Test Marker Observation

Found 1 test without category markers (test_custom_env_file_location in tests/aignostics/platform/settings_test.py). This is a pre-existing issue not introduced by this PR and does not affect the sphinx-toolbox upgrade validation.

Recommendation: Address in a separate PR to add @pytest.mark.unit or appropriate marker.

Documentation Build Output

Built successfully with 43 warnings - all are pre-existing duplicate object warnings for aignostics.platform.Settings fields. None are related to sphinx-toolbox v4.

Example warnings:

WARNING: duplicate object description of aignostics.platform.Settings.api_root
WARNING: duplicate object description of aignostics.platform.Settings.application_cache_ttl
...

These warnings existed before this upgrade and are unrelated to the dependency change.


Final Recommendation

APPROVE AND MERGE

This dependency upgrade is:

  • Safe: No breaking changes affecting this codebase
  • Validated: All quality gates passed locally
  • CI/CD Ready: Build Native completed, main CI/CD pipeline queued
  • Well-tested: Documentation builds successfully with v4.0.0
  • Low risk: Dev-only dependency with zero runtime impact

@codecov
Copy link

codecov bot commented Nov 11, 2025

Codecov Report

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

❗ There is a different number of reports uploaded between BASE (3eddfe4) and HEAD (a36483a). Click for more details.

HEAD has 6 uploads less than BASE
Flag BASE (3eddfe4) HEAD (a36483a)
7 1

see 22 files with indirect coverage changes

@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot Automated pull requests or issues dependencies Pull requests that update a dependency file renovate Pull requests from Renovate skip:test:long_running Skip long-running tests (≥5min)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant