Cleanup warning when building docs
Metadata
Current evaluation
Resolved by merged PR #609 (commit a72d1f26), which cleaned up Sphinx warnings and made documentation builds fail on warnings with -W.
Resolution: closed resolved
Reason: PR #609 was merged as commit a72d1f26. It cleaned existing Sphinx warnings, enabled warning-as-error builds, and suppressed known Pydantic ErrorDict warnings.
Evaluated by: mr-cal-bot
No scores available.
Issue body
The current sphinx-build output contains *a lot* of warnings; some of them can be disregarded but some of them can be major, like disabling the autogenerated docs from the code altogether (see #346). Ideally we should cleanup the warnings and then build with `-W` so that new warnings fail the build. Cleaning up the warnings isn't as straightforward as we might like because some of them are from the various sphinx plugins interacting badly with Pydantic.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Resolved by merged PR #609 (commit a72d1f26), which cleaned up Sphinx warnings and made documentation builds fail on warnings with -W. | |
| stealth/space-bunny-alpha | — | closed resolved | Fixed by merged PR #609 (commit a72d1f26), which cleaned up Sphinx warnings and enabled `-W` to fail documentation builds on warnings. | |
| stealth/space-bunny-alpha | — | closed resolved | Sphinx warnings were cleaned and warnings-as-errors enabled by merged PR #609 (commit a72d1f26), so sphinx-build now runs with -W. | |
| qwen/qwen3.6-35b-a3b | — | — | Fixed. Documentation build warnings were cleaned and sphinx-build now uses the -W flag to fail on new warnings. This resolves plugin and Pydantic compatibility issues that previously caused excessive output. | |
| qwen/qwen3.6-35b-a3b | — | — | Resolved by cleaning up Sphinx build warnings and enabling strict mode. The sphinx-build command now uses the -W flag, ensuring future warnings will fail the build process. | |
| qwen/qwen3.6-35b-a3b | — | — | Sphinx documentation build warnings were cleaned, enabling the -W flag to fail on new warnings. The issue was resolved by @upils. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Resolved by cleaning Sphinx build warnings and enabling the -W flag, which now fails the build on new warnings. The issue is closed. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/craft-parts#609
(confidence 100%)
Merged PR #609 directly implemented the requested Sphinx warning cleanup and -W enforcement.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #383 docs: fail on RTD warnings | starbase | merged | Merged PR #383 in commit f67abd7, setting Sphinx fail_on_warning so Read the Docs builds fail on documentation warnings instead of silently ignoring them. | |
| #2280 docs: resolve local build errors | charmcraft | merged | Merged PR #2280 (a60e7229) fixed local docs builds by excluding the affected integrations and JLink plugin pages from Sphinx processing. | |
| #609 chore(docs): cleanup sphinx warnings | craft-parts | merged | Merged as a72d1f26, PR #609 cleaned existing Sphinx warnings, made Read the Docs fail on new warnings, and filtered Pydantic ErrorDict warnings. | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. | |
| #2096 fix(style): ignore docs/_build | charmcraft | merged | Merged PR #2096 via commit 5e2adcb0, making sphinx-lint ignore generated docs/_build artifacts and fixing #2091. |