chore: use Canonical's sphinx-docs-starter-pack
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged integration of Canonical's sphinx-docs-starter-pack. Documentation dependencies were moved to a requirements file and removed from pyproject.toml, resolving issue #187. The maintainer chose direct package integration over a git submodule. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #979 chore: rename starter pack submodule | rockcraft | merged | Merged the rename of the documentation submodule to sphinx-docs-starter-pack. CI passed after a separate PR resolved a lint error. Release notes and contributor sync instructions were added. | |
| #122 chore(deps): update documentation dependencies | craft-store | merged | Merged automated updates for documentation dependencies including sphinx-lint, sphinx-tabs, sphinx-reredirects, sphinxext-opengraph, and lxd-sphinx-extensions. Changes passed CI, received approval, and were merged. | |
| #194 chore(deps): update documentation dependencies | craft-store | merged | Merged automated updates for documentation dependencies furo, sphinx-design, and sphinx-notfound-page. Approved by two reviewers, passed CI checks, and merged with minimal changes across two files. | |
| #174 chore(deps): update documentation dependencies | craft-store | merged | Merged automated documentation dependency updates via Renovate. Updated Sphinx to 7.3.7, sphinx-design to 0.6.0, sphinx-notfound-page to 1.0.2, and sphinx-reredirects to 0.1.4. Approved by two reviewers, passed CI, and merged. | |
| #643 chore(deps): update documentation dependencies | craft-parts | merged | Merged automated documentation dependency updates. Renovate upgraded sphinx-autodoc-typehints and four sphinxcontrib packages to latest patch versions. Approved by two reviewers and passed CI before merge. | |
| #300 docs: refactor documentation for sphinx-starter-pack | rockcraft | merged | Merged documentation refactoring to align with sphinx-starter-pack. Approved by three reviewers and passed CI. Modified 28 files (+351/-63) to standardize structure, validate with pylint, shellcheck, and sphinx, and simplify future integration. | |
| #147 chore(deps): update documentation dependencies | craft-store | merged | Merged automated documentation dependency updates. Renovate upgraded sphinx-lint, sphinxext-opengraph, and lxd-sphinx-extensions to latest patch versions. Approved by reviewer, passed CI, and merged with minimal changes. | |
| #4728 chore(deps): update documentation dependencies | snapcraft | merged | Merged automated documentation dependency updates. Renovate upgraded furo, sphinx-basic-ng, sphinx_design, and sphinxcontrib packages. PR passed CI checks and reviewer approval before merge. | |
| #745 chore(deps): update documentation dependencies | craft-parts | merged | Merged an automated Renovate update for documentation dependencies, upgrading Sphinx, furo, sphinx-autobuild, sphinx-autodoc-typehints, and sphinx-design. Approved by two reviewers and passed CI before integration. | |
| #538 chore(deps): update documentation dependencies (major) | rockcraft | merged | Merged automated dependency update upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. Approved by reviewers, passed CI, and merged with a minimal two-line change. |