docs: use Sphinx + Readthedocs
Metadata
Current evaluation
Merged #163, migrating the documentation to a canonical-sphinx-based Sphinx project and connecting it to Read the Docs builds.
Resolution: closed resolved
Reason: PR #163 was approved and merged. The resulting docs configuration enables canonical-sphinx and redirect support, confirming the documentation migration landed.
Evaluated by: mr-cal-bot
No scores available.
Issue body
These series of commits update the docs to a "proper" Sphinx project (using the canonical-sphinx extension), and hook them up to get readthedocs builds.
The build for this PR itself is here: https://canonical-fetch-service--163.com.readthedocs.build/en/163/ (note that you need to be logged in to access it).
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged #163, migrating the documentation to a canonical-sphinx-based Sphinx project and connecting it to Read the Docs builds. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #163 converted the documentation to a canonical-sphinx-based Sphinx project and connected it to Read the Docs builds. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation migration to Sphinx using the canonical-sphinx extension and integrated ReadTheDocs for automated builds. Approved by two reviewers, modifying eight files with 206 additions and 102 deletions. |
Update history
| Date | Change |
|---|---|
| created |
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. | |
| #23 docs: use canonical-sphinx | craft-grammar | merged | Merged #23 to migrate the documentation build to canonical-sphinx, resolving the proposed change in commit daf794a. | |
| #106 docs: use canonical-sphinx | craft-archives | merged | Merged PR #106 switched the documentation build to canonical-sphinx in commit 9f73ab6. | |
| #325 docs: use canonical-sphinx | craft-application | merged | Merged PR #325 in commit 8ca97e1a, migrating the docs to canonical-sphinx and removing unused extensions and configuration. | |
| #249 docs: use canonical-sphinx extension | craft-cli | merged | Merged PR #249 adopted the canonical-sphinx extension, removing 1,134 lines of legacy documentation configuration. | |
| #720 docs: use canonical-sphinx | craft-parts | merged | Merged PR #720 as commit 278feb8d, migrating craft-parts docs to canonical-sphinx and removing legacy configuration across three files. | |
| #81 docs: initialise docs | starflow | merged | Merged docs scaffold: 14-file Sphinx/Read the Docs setup (conf.py, index, .sphinx extension config) with no real content; tutorial category omitted by design. PR builds public, main builds private until content exists. | |
| #4055 docs: import Sphinx scaffolding for documentation work | snapcraft | merged | Merged as commit ebc549ed4 ("docs: import Sphinx scaffolding for documentation work (#4055)"), adding Starbase-derived Sphinx docs scaffolding (docs/conf.py, tox docs config, 13 files, +513 lines). | |
| #501 docs: update Sphinx theme | craft-parts | merged | Merged as ed49f727, updating the Sphinx theme and documentation configuration; follow-up #502 (fd11dddc) repaired tox documentation builds. | |
| #4367 docs: update sphinx theme | snapcraft | merged | Merged as commit aa64666ef, updating the Sphinx documentation theme; it replaced earlier attempt #4263 and picked up the #4375 fixes that restored broken doc builds. |