docs: fail on RTD warnings
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: canonical/starbase#383 was merged as commit f67abd7 and added fail_on_warning: true to .readthedocs.yaml, making RTD warning failures visible in CI.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint && make test`?
---
This addresses a reoccurring and silent problem in Snapcraft where doc warnings would not show up in CI ([source](https://github.com/canonical/snapcraft/pull/5468), [source](https://github.com/canonical/snapcraft/pull/5436)).
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #383 in commit f67abd7, making documentation builds fail on Sphinx warnings so Read the Docs warnings cannot be silently ignored. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged docs: fail on RTD warnings, making Read the Docs warning failures visible in CI to prevent silent documentation build problems. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged configuration to fail CI builds on ReadTheDocs warnings, resolving a recurring issue where documentation warnings were silently ignored. Approved by two reviewers and passed all checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged a configuration update to fail CI builds on ReadTheDocs warnings. This resolves a recurring issue where documentation build warnings were silently ignored, ensuring doc errors are now caught during continuous integration. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/snapcraft#5468
(confidence 95%)
Cited as prior work that similarly made documentation builds fail on RTD warnings.
-
Related To:
canonical/snapcraft#5436
(confidence 90%)
Cited as motivation for surfacing documentation warnings in CI.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #347 Cleanup warning when building docs | craft-parts | closed | Resolved by merged PR #609 (commit a72d1f26), which cleaned up Sphinx warnings and made documentation builds fail on warnings with -W. | |
| #4258 docs: enable RTD builds | snapcraft | merged | Merged PR #4258 enabled Read the Docs builds by adding documentation build configuration; merged as commit 4d0d75112. | |
| #5468 docs: fix RTD build | snapcraft | merged | Merged PR #5468 as 0157e5b15, fixing RTD builds by renaming Matter SDK docs, unignoring migrated docs, and failing on warnings; confdb ToC warnings remained in #5200. |