chore: use Canonical's sphinx-docs-starter-pack
Metadata
Current evaluation
Merged PR #197 (77a3b26) adopted Canonical's Sphinx starter pack, moved documentation dependencies to a requirements file, and fixed #187.
Resolution: closed resolved
Reason: PR #197 was approved and merged as commit 77a3b26, updating the documentation structure and explicitly fixing issue #187.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This commit adds Canonical's starter pack for Sphinx documentation. A consequence of this is that the doc-related dependencies are listed in a requirements file, so we drop those optional-deps from pyproject.toml.
Fixes #187
- [ ] Have you followed the guidelines for contributing?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `tox`?
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #197 (77a3b26) adopted Canonical's Sphinx starter pack, moved documentation dependencies to a requirements file, and fixed #187. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #197 as 77a3b26, adopting Canonical’s Sphinx documentation starter pack, moving documentation dependencies to a requirements file, and resolving #187. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #197 (54a895b) adopted Canonical's Sphinx documentation starter pack and moved documentation dependencies from pyproject.toml to a requirements file, fixing #187. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #197 in 77a3b26 adopted Canonical’s Sphinx documentation starter pack, moving documentation dependencies from optional pyproject dependencies to a requirements file. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged to main following approval and CI checks. Integrated Canonical's Sphinx documentation starter pack, relocating doc dependencies to a requirements file across 31 changed files. Resolves #187. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-cli#187
(confidence 100%)
PR #197 explicitly fixes #187 by adopting Canonical's requested documentation template.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1341 chore: rename starter pack submodule | craft-parts | merged | Merged in #1341 via 1803cfa8, renaming the documentation submodule to sphinx-docs-starter-pack and updating references and contributor resync instructions. | |
| #576 chore(deps): update dependency canonical-sphinx to v0.6.0 | fetch-service | merged | Merged PR #576 via commit 469fefe, updating canonical-sphinx from 0.5.2 to 0.6.0 in the documentation requirements. | |
| #355 chore(deps): update dependency canonical-sphinx to v0.4.0 | fetch-service | merged | Merged PR #355 in commit b7f207a, updating canonical-sphinx from 0.3.0 to 0.4.0 in the documentation requirements. | |
| #235 chore(deps): update dependency canonical-sphinx to v0.2.0 | fetch-service | merged | Renovate PR #235 merged (commit 65e3cd8), bumping docs/requirements.txt pin of canonical-sphinx from ==0.1.0 to ==0.2.0 for the Sphinx docs build. | |
| #591 chore(deps): update documentation dependencies | craft-parts | merged | Documentation dependencies were updated and merged via refreshed PR #643 (c9de9625), upgrading sphinx-autodoc-typehints to 1.25.2 and Sphinx contrib packages to 1.0.7/1.0.5. | |
| #377 chore(deps): update dependency canonical-sphinx to v0.5.1 | fetch-service | merged | Renovate PR #377 was merged, updating canonical-sphinx from 0.4.0 to 0.5.1 in commit 653a913. | |
| #538 chore(deps): update documentation dependencies (major) | rockcraft | merged | Merged PR #538 in commit b007f265, upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. | |
| #320 chore(deps): update dependency canonical-sphinx to v0.3.0 | fetch-service | merged | Renovate dependency bump of canonical-sphinx 0.2.0 -> 0.3.0 merged into main via commit 3c20a5a, updating docs/requirements.txt (approved by 2 reviewers). | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. | |
| #641 chore(deps): update dependency canonical-sphinx to v0.7.1 | fetch-service | closed | Renovate dependency bump of canonical-sphinx from 0.6.0 to 0.7.1 was approved and merged into main as commit 015a619, updating docs/requirements.txt (now pins canonical-sphinx==0.7.1). |