← Back to issue list

docs: use canonical-sphinx

View original Github issue

Metadata

Project
rockcraft
Number
#559
Type
pull request
State
merged
Author
tigarmo
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation build update to use canonical-sphinx. Added the dependency to setup.cfg and regenerated requirements-doc.txt by freezing the doc environment. Submitted by maintainer tigarmo.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#4766 docs: use canonical-sphinx snapcraft merged 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.
92%
#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).
88%
#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.
87%
#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.
86%
#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.
86%
#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.
86%
#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.
82%
#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.
80%
#65 docs: fix sphinx doc generation and update docstrings craft-parts merged Merged after two approvals and passing CI. Fixed Sphinx doc generation by importing modules to resolve import cycles, and added missing parameter descriptions to docstrings across five files.
78%
#163 docs: use Sphinx + Readthedocs fetch-service merged 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.
77%