docs: fix RTD build
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Resolved the ReadTheDocs build failure by renaming matter sdk documentation to use underscores, removing the files from the ignore list, and enabling warnings as errors. A related table of contents warning was flagged for separate tracking. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #383 docs: fail on RTD warnings | starbase | merged | 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. | |
| #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. | |
| #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. | |
| #676 ci: fix building rtd docs for fork PRs | rockcraft | closed | Closed without merging. The one-line CI fix for building RTD docs on fork PRs received no reviews or checks and was abandoned. | |
| #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. | |
| #258 docs: update readme and template, fix build error | starbase | merged | Merged after two reviewer approvals and passing CI. Updated README wording, added doc preparation details, and disabled PDF and EPUB generation to resolve build errors. All changes passed tests with 100% coverage. | |
| #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. | |
| #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. |