Set up docs publishing on RTD
Metadata
Current evaluation
Merged after review and passing CI. Configured ReadTheDocs publishing using the Docs Starter Pack, updated documentation checks, and removed the legacy tox build process.
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 `tox`? (well, sort of...)
-----
This PR:
- Adopts the [Docs Starter Pack](https://github.com/canonical/sphinx-docs-starter-pack) for publishing on ReadTheDocs.
- Switches docs checks to the 'Starter Pack way', and so it removes the `tox` build and "check".
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after review and passing CI. Configured ReadTheDocs publishing using the Docs Starter Pack, updated documentation checks, and removed the legacy tox build process. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Integrated the Docs Starter Pack to automate ReadTheDocs publishing and replaced the legacy tox build and check steps. Project coverage remains stable at 85.13%. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Replaced the tox documentation build with the Docs Starter Pack for ReadTheDocs publishing. Documentation checks now follow the Starter Pack workflow. Project coverage remains at 85.13%. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. |