docs: use canonical-sphinx
Metadata
Current evaluation
Merged in canonical/snapcraft#4766 (678d5f50f), switching docs to canonical-sphinx, adding setup.py docs_requires, and consolidating frozen dependencies in docs/requirements.txt.
Resolution: closed resolved
Reason: PR #4766 was approved and merged as commit 678d5f50f. It centralized documentation dependencies and removed the excess requirements files.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This commit also does some general house-keeping of the docs:
- Add a "docs_requires" list of dependencies to setup.py, so we can update docs/requirements.txt more easily;
- Remove the excess requirements files by keeping all (frozen) deps in docs/requirements.txt.
- [ ] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `tox run -m lint`?
- [ ] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`)
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/snapcraft#4766 (678d5f50f), switching docs to canonical-sphinx, adding setup.py docs_requires, and consolidating frozen dependencies in docs/requirements.txt. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR (commit 678d5f50f) switched docs to canonical-sphinx, consolidated deps into docs/requirements.txt and added docs_requires to setup.py; unrelated test failures fixed in #4772. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/snapcraft#4766 (678d5f50f): documentation switched to canonical-sphinx, dependencies were consolidated, and docs_requires was added to setup.py. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update switching to canonical-sphinx. Consolidated requirements files and added docs_requires to setup.py. Approved by two reviewers with passing CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged updates to use canonical-sphinx for documentation. Consolidated frozen dependencies into docs/requirements.txt and added docs_requires to setup.py. Initial test failures were unrelated and resolved in a separate PR. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. | |
| #559 docs: use canonical-sphinx | rockcraft | merged | Merged PR #559 (commit 041e3137) switched Rockcraft docs to canonical-sphinx, added the dependency to setup.cfg, and regenerated requirements-doc.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. | |
| #106 docs: use canonical-sphinx | craft-archives | merged | Merged PR #106 switched the documentation build to canonical-sphinx in commit 9f73ab6. | |
| #434 docs: use tox for sphinx docs | craft-parts | closed | Closed unmerged as redundant: canonical/craft-parts#433 merged the broader Starbase tox setup in 7dbf0405; equivalent Sphinx support landed via canonical/snapcraft#4273 at d25b49d63. | |
| #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. | |
| #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. | |
| #135 docs(deps): update canonical-sphinx | craft-archives | merged | Merged PR #135 updated the canonical-sphinx documentation dependency in commit 8a38995 after two approvals. |