Set up docs publishing on RTD
Metadata
Current evaluation
Merged #24, adopting Canonical's Docs Starter Pack for Read the Docs and replacing the tox-based documentation build and checks.
Resolution: closed resolved
Reason: PR #24 was merged in commit 34b3be8. Commit 9f95ca1 added the RTD setup, and 1c2becf switched documentation checks to the Starter Pack workflow.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged #24, adopting Canonical's Docs Starter Pack for Read the Docs and replacing the tox-based documentation build and checks. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged (commit 34b3be8, "Merge pull request #24 from rkratky/FR-6791_bootstrap-rtd"): adopted Canonical's Sphinx Docs Starter Pack, added .readthedocs.yaml/common.mk and Diátaxis docs layout, and replaced the tox docs build/check with Starter Pack checks. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #24 in commit 34b3be8, adding Read the Docs publishing via the Docs Starter Pack and replacing tox documentation build/check commands. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #24, adding ReadTheDocs publishing through the Docs Starter Pack and replacing legacy tox documentation checks. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #24 in commit 34b3be8, adding Canonical’s Docs Starter Pack for ReadTheDocs publishing and replacing the legacy tox documentation build with the starter-pack checks. | |
| 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%. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1926 Docs: Rebase against newer starter pack | charmcraft | open | Docs maintenance task to rebase against newer RTD starter pack; appears completed by commit 6264ff78 updating the canonical starter pack to 1.5. |