docs: use canonical-sphinx
Metadata
Current evaluation
Merged PR #559 (commit 041e3137) switched Rockcraft docs to canonical-sphinx, added the dependency to setup.cfg, and regenerated requirements-doc.txt.
Resolution: closed resolved
Reason: PR #559 was merged with approval from two reviewers. Commit 041e3137 implements the canonical-sphinx documentation tooling change and dependency updates.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This requires updating requirements-doc.txt via:
1) adding 'canonical-sphinx' as a dep in setup.cfg;
2) creating an env with `.[doc]`
3) freezing the env via `pip list --format=freeze > requirements-doc.txt`
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #559 (commit 041e3137) switched Rockcraft docs to canonical-sphinx, added the dependency to setup.cfg, and regenerated requirements-doc.txt. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #559 updates documentation tooling to use canonical-sphinx, adds the dependency to setup.cfg, and regenerates requirements-doc.txt from the .[doc] environment. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update to adopt canonical-sphinx. Added the dependency to setup.cfg and regenerated requirements-doc.txt by freezing the doc environment. Approved by two reviewers with passing CI across seven files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged update to switch documentation dependencies to canonical-sphinx. The maintainer added the package to setup.cfg, regenerated requirements-doc.txt, and applied the change to standardize the Sphinx toolchain. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #300 docs: refactor documentation for sphinx-starter-pack | rockcraft | merged | Merged PR #300 in commit 66911e8e, refactoring 28 documentation files to align Rockcraft with sphinx-starter-pack and ease future integration. | |
| #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. | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. | |
| #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. | |
| #106 docs: use canonical-sphinx | craft-archives | merged | Merged PR #106 switched the documentation build to canonical-sphinx in commit 9f73ab6. | |
| #900 build(docs): update build, add sphinx sitemap, update site links | rockcraft | merged | PR #900 merged as commit c1fea236 (ROCKCRAFT-237/238): updated the docs build, added sphinx-sitemap with the dirhtml builder, refreshed site links, and aligned local/CI docs tooling. | |
| #4766 docs: use canonical-sphinx | snapcraft | merged | Merged in canonical/snapcraft#4766 (678d5f50f), switching docs to canonical-sphinx, adding setup.py docs_requires, and consolidating frozen dependencies in docs/requirements.txt. | |
| #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. | |
| #135 docs(deps): update canonical-sphinx | craft-archives | merged | Merged PR #135 updated the canonical-sphinx documentation dependency in commit 8a38995 after two approvals. | |
| #562 docs: update to canonical-sphinx | craft-providers | merged | Merged PR (commit 9897239) enabled the canonical-sphinx docs extension and removed sphinx-docs-starter-pack submodule references in craft-providers. Leftover submodule dir was later cleaned up in #713. |