chore(docs): cleanup sphinx warnings
Metadata
Current evaluation
Merged as a72d1f26, PR #609 cleaned existing Sphinx warnings, made Read the Docs fail on new warnings, and filtered Pydantic ErrorDict warnings.
Resolution: closed resolved
Reason: PR #609 was merged into main as commit a72d1f26. It resolved documentation warning noise and configured the Read the Docs build to reject newly introduced warnings.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This commit cleans up the warnings generated when building the Sphinx docs, and makes the Readthedocs build fail if any new warnings are generated. For pydantic.ErrorDict specifically, the only way I could find to silence those warnings was to altogether drop them before they are emitted, unfortunately.
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged as a72d1f26, PR #609 cleaned existing Sphinx warnings, made Read the Docs fail on new warnings, and filtered Pydantic ErrorDict warnings. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #609 to clean up Sphinx documentation warnings and make Read the Docs fail on new warnings; pydantic.ErrorDict warnings were filtered. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged cleanup of Sphinx documentation warnings and configuration to fail the ReadTheDocs build on new warnings. Dropped pydantic.ErrorDict warnings to silence them. Approved and passed CI. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged cleanup of Sphinx documentation warnings. Configured ReadTheDocs to fail on new warnings and removed pydantic.ErrorDict warnings to silence them. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #612 chore: cleanup pydantic warnings | craft-providers | merged | Merged PR #612 as commit c106d34, cleaning up Pydantic warnings with a minimal two-file configuration change. | |
| #538 chore(deps): update documentation dependencies (major) | rockcraft | merged | Merged PR #538 in commit b007f265, upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. | |
| #189 chore(deps): update documentation dependencies | craft-store | merged | Renovate PR #189 merged as commit 3b092a3, bumping docs pins to sphinx 7.4.7, furo 2024.7.18, sphinx-reredirects 0.1.5, sphinx-toolbox 3.7.0 (approved by 2 reviewers). | |
| #122 chore: eliminate pydantic warnings | craft-archives | merged | Merged PR #122 eliminated Pydantic warnings, landing as commit 00b9b3b after approval by two reviewers. | |
| #141 chore(deps): update dependency docs/sphinx-lint to v0.8.1 | starbase | merged | Renovate PR #141 was merged, updating docs/sphinx-lint from 0.6.8 to 0.8.1 in commit 62cafda. | |
| #122 chore(deps): update documentation dependencies | craft-store | merged | Renovate PR merged as commit 2dfd465, bumping docs deps: lxd-sphinx-extensions 0.0.14→0.0.15, sphinx-lint 0.8.1→0.9.0, sphinx-reredirects 0.1.2→0.1.3, sphinx-tabs 3.4.1→3.4.4, sphinxext-opengraph 0.8.2→0.9.0. | |
| #191 chore(deps): update dependency docs/sphinx-lint to v0.8.1 | craft-cli | merged | Merged PR #191 as commit 12dc061, updating docs/sphinx-lint from 0.6.8 to 0.8.1 after approval. | |
| #160 chore(deps): update dependency docs/sphinx-lint to v0.9.1 | craft-application | merged | Merged PR #160 upgraded docs/sphinx-lint from 0.8.1 to 0.9.1 in commit f5d236aa. | |
| #368 chore(deps): update documentation dependencies | craft-providers | merged | Renovate dependency bump PR merged as commit 5eae8d4 (2023-07-28): docs/sphinx-lint 0.6.7→0.6.8 and docs/sphinx-toolbox 3.4.0→3.5.0, +2/-2 lines in the docs requirements. | |
| #180 chore(deps): update dependency docs/sphinx to v7 | craft-cli | merged | Merged PR #180 as commit 91c4b88, updating docs/sphinx from >=6.2.1,<7.0 to >=7.2.6,<7.3. |