docs: enable RTD builds
Metadata
Current evaluation
Merged into main after approval and passing CI. The change enabled ReadTheDocs builds by adding documentation configuration to a single file.
Suggested action: —
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/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 `pytest tests/unit`?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged into main after approval and passing CI. The change enabled ReadTheDocs builds by adding documentation configuration to a single file. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged into main to enable ReadTheDocs builds. Changes passed lint and unit tests. Codecov noted a minor 0.03% coverage decrease upon integration. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged into main. The pull request enables ReadTheDocs builds. Codecov noted a 0.03% coverage decrease upon integration. Maintainer dboddie approved and finalized the documentation update. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #24 Set up docs publishing on RTD | imagecraft | merged | Merged after review and passing CI. Configured ReadTheDocs publishing using the Docs Starter Pack, updated documentation checks, and removed the legacy tox build process. | |
| #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. | |
| #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. | |
| #36 docs: move API gen to conf.py for RTD to pick up | craft-cli | merged | Merged. Moved API documentation generation to conf.py to enable Read The Docs to build it automatically, with minor typo corrections. Approved and passed CI. | |
| #81 docs: initialise docs | starflow | merged | Merged documentation initialization, establishing a basic ReadTheDocs structure with public PR builds and private main builds until content is added. Approved by two reviewers, passed all CI checks, and added 2225 lines across 14 files. | |
| #2143 build(docs): use uv for RTD build | charmcraft | merged | Merged update to the ReadTheDocs configuration to use uv for builds. Imports the latest .readthedocs.yaml from starbase, approved by three reviewers, and modifies one file. |