docs: use canonical-sphinx
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Updated documentation build to use canonical-sphinx, added docs_requires to setup.py, and consolidated requirements into docs/requirements.txt. Unrelated test failures were resolved separately. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #559 docs: use canonical-sphinx | rockcraft | merged | 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. | |
| #325 docs: use canonical-sphinx | craft-application | merged | Merged documentation update to adopt canonical-sphinx and remove unused extensions. Approved by two reviewers, passed CI, and modified four files (+30/-83 lines). | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged documentation update to adopt canonical-sphinx. Approved by two reviewers, modifying two files with 45 additions and 36 deletions. | |
| #106 docs: use canonical-sphinx | craft-archives | merged | Merged documentation update to use canonical-sphinx. Approved by two reviewers, passed CI and codecov checks, and successfully integrated into the codebase. | |
| #720 docs: use canonical-sphinx | craft-parts | merged | Merged documentation update to adopt canonical-sphinx. Approved by two reviewers, the change modifies three files, removing 167 lines and adding 45 to standardize the build configuration. | |
| #23 docs: use canonical-sphinx | craft-grammar | merged | Merged after two approvals and passing CI. Updates documentation to use canonical-sphinx, modifying 7 files with a net reduction of 72 lines. | |
| #249 docs: use canonical-sphinx extension | craft-cli | merged | Merged following approval by two reviewers. The change integrates the canonical-sphinx extension into the documentation build system, updating 22 files and removing over 1000 lines of legacy configuration. | |
| #135 docs(deps): update canonical-sphinx | craft-archives | merged | Updating the canonical-sphinx dependency was approved by two reviewers, passed CI checks, and successfully merged. The commit modified a single line in one file. | |
| #1501 build(docs): update and clean docs dependencies | craft-parts | merged | Merged following approval by three reviewers. Updated and cleaned documentation dependencies, removing sphinx-pydantic in favor of pydantic-kitbash. All required CI checks passed. | |
| #983 docs: update links | rockcraft | merged | Merged documentation update that replaces hardcoded URLs with intersphinx and Sphinx references, and fixes redirected external links. Approved by three reviewers and passed CI checks after resolving initial lint and test failures. |