← Back to issue list

chore(docs): cleanup sphinx warnings

View original Github issue

Metadata

Project
craft-parts
Number
#609
Type
pull request
State
merged
Author
tigarmo
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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
#547 chore(deps): update documentation dependencies craft-parts merged Merged Renovate PR updating Sphinx documentation dependencies. Author manually adjusted versions to fix ReadTheDocs build failures. Approved by reviewers and CI passed prior to merge.
79%
#194 chore(deps): update documentation dependencies craft-store merged Merged automated updates for documentation dependencies furo, sphinx-design, and sphinx-notfound-page. Approved by two reviewers, passed CI checks, and merged with minimal changes across two files.
77%
#643 chore(deps): update documentation dependencies craft-parts merged Merged automated documentation dependency updates. Renovate upgraded sphinx-autodoc-typehints and four sphinxcontrib packages to latest patch versions. Approved by two reviewers and passed CI before merge.
77%
#538 chore(deps): update documentation dependencies (major) rockcraft merged Merged automated dependency update upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. Approved by reviewers, passed CI, and merged with a minimal two-line change.
76%
#122 chore(deps): update documentation dependencies craft-store merged Merged automated updates for documentation dependencies including sphinx-lint, sphinx-tabs, sphinx-reredirects, sphinxext-opengraph, and lxd-sphinx-extensions. Changes passed CI, received approval, and were merged.
76%
#147 chore(deps): update documentation dependencies craft-store merged Merged automated documentation dependency updates. Renovate upgraded sphinx-lint, sphinxext-opengraph, and lxd-sphinx-extensions to latest patch versions. Approved by reviewer, passed CI, and merged with minimal changes.
76%
#174 chore(deps): update documentation dependencies craft-store merged Merged automated documentation dependency updates via Renovate. Updated Sphinx to 7.3.7, sphinx-design to 0.6.0, sphinx-notfound-page to 1.0.2, and sphinx-reredirects to 0.1.4. Approved by two reviewers, passed CI, and merged.
76%
#122 chore: eliminate pydantic warnings craft-archives merged Merged after two approvals and passing CI. Refactored three files to eliminate pydantic deprecation warnings, adding 24 lines and removing 15.
76%
#745 chore(deps): update documentation dependencies craft-parts merged Merged an automated Renovate update for documentation dependencies, upgrading Sphinx, furo, sphinx-autobuild, sphinx-autodoc-typehints, and sphinx-design. Approved by two reviewers and passed CI before integration.
76%
#176 chore(deps): update documentation dependencies craft-cli merged Merged automated updates for documentation dependencies: furo, sphinx-design, sphinx-lint, and sphinx-toolbox. Approved and merged without impacting code coverage.
75%