docs: fix RTD build
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: PR #5468 merged as commit 0157e5b15 after approval, with all CI checks passing. It corrected the documentation paths and ignore rules and enabled warning failures to prevent RTD regressions.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint`?
- [x] Have you successfully run `make test`?
---
* Renames the matter sdk docs to use underscores to match the other plugins in Snapcraft and Craft Parts.
* Remove migrated docs from the ignored list. Again, the [build on RTD](https://app.readthedocs.com/projects/canonical-snapcraft/builds/3014663/) doesn't fail on these warnings but fails locally:
* Fail on warnings so we catch this in the future.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/snapcraft#5468 (0157e5b15), fixing RTD builds by renaming Matter SDK docs, removing migrated docs from the ignore list, and treating warnings as errors. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Fixed the ReadTheDocs build by renaming matter sdk docs to underscores, removing them from the ignore list, and enabling strict warning checks. Related ToC warnings tracked separately. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/snapcraft#5200
(confidence 98%)
Review discussion identified the remaining pre-8.9 confdb ToC warnings as the same underlying documentation issue, but deferred them to separate follow-up.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #4258 docs: enable RTD builds | snapcraft | merged | Merged PR #4258 enabled Read the Docs builds by adding documentation build configuration; merged as commit 4d0d75112. | |
| #676 ci: fix building rtd docs for fork PRs | rockcraft | closed | PR #676 was closed unmerged without reviews or CI, abandoning its one-line RTD fix for building documentation from fork pull requests. | |
| #6295 docs: fix version numbering | snapcraft | merged | Merged #6295 (commit 8456b4421), fixing docs version numbering to use Read the Docs branch metadata and keep local and RTD builds consistent. | |
| #157 docs: use rtd config from starbase | craft-archives | merged | Merged PR #157 as 00286fd, importing Starbase's RTD configuration after #143 to restore failing documentation builds. | |
| #258 docs: update readme and template, fix build error | starbase | merged | Merged PR #258 in commit 7d2790e, improving README and docs-preparation guidance and disabling PDF/EPUB generation to restore the documentation build. | |
| #5901 docs: fix canonical URL | snapcraft | merged | Merged PR #5901 (commit 02d84057a), updating docs to use RTD's versioned canonical URLs and omit generated pages from the sitemap. | |
| #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. | |
| #219 docs: fix readthedocs documentation generation | craft-parts | merged | Merged PR #219 (commit c70294ee, merge 996ed24e) fixed RTD doc builds: added missing packages to the readthedocs env, indexed the changelog, and removed outdated python-apt from setup.py. Shipped in release 1.7.0. |