docs: fail on RTD warnings
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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 issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5468 docs: fix RTD build | snapcraft | merged | Merged PR fixing the ReadTheDocs build by renaming matter SDK docs to underscores, removing them from the ignore list, and enabling fail-on-warnings. Approved with all CI checks passing. Related ToC warnings deferred. | |
| #4258 docs: enable RTD builds | snapcraft | merged | Merged into main after approval and passing CI. The change enabled ReadTheDocs builds by adding documentation configuration to a single file. | |
| #401 ci: make RTD use `make docs` | starbase | merged | Merged after approval by three reviewers and passing CI checks. Updated CI configuration to use make docs for ReadTheDocs builds, modifying two files with seven additions and three deletions. | |
| #400 ci: make RTD use `make docs` | starbase | closed | Merged to configure ReadTheDocs to use make docs for documentation builds. All CI checks passed and the change was accepted without review comments. | |
| #157 docs: use rtd config from starbase | craft-archives | merged | Merged to update the ReadTheDocs configuration from starbase, fixing documentation build failures. Approved by two reviewers and integrated after passing CI checks. | |
| #586 docs: fix incorrect version in documentation | rockcraft | merged | Merged to resolve #584. Configured ReadTheDocs to fetch tags and updated non-release documentation to display dev instead of misleading release strings. Approved by two reviewers with passing CI. | |
| #2280 docs: resolve local build errors | charmcraft | merged | Merged. Resolved local documentation build failures by adding files causing undefined substitution and toctree warnings to the exclude_patterns list. Approved by two reviewers and passed CI. | |
| #5139 fix(docs): display examples correctly in RTD | snapcraft | merged | Merged a fix correcting auto-generated documentation rendering on ReadTheDocs. The change resolved command example display issues, received two approvals, passed CI checks, and was successfully integrated. | |
| #219 docs: fix readthedocs documentation generation | craft-parts | merged | Merged. Resolved ReadTheDocs build failures by installing missing environment packages, adding the changelog to the documentation index, and removing python-apt from setup to prevent version conflicts. Approved and passed CI. | |
| #9 docs: update build procedure and fix warning | craft-store | merged | Merged updates consolidate API documentation configuration in conf.py for ReadTheDocs and fix a build warning. Approved by one reviewer, passed CI, and notes propagation to related craft-* projects. |