docs: refactor documentation for sphinx-starter-pack
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
This commit refactor the documentation in order to be able
to merge easily the sphix-starter-pack after when they add
new functionnallity.
each file have been check with pylint,shellcheck and sphinx.
Signed_Off_By: Samir Akarioh <samir.akarioh@canonical.com>
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation refactoring to align with sphinx-starter-pack. Restructured requirements-docs.txt, minimized file changes, and validated all documentation with pylint, shellcheck, and sphinx. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation refactoring to align with sphinx-starter-pack standards. Adjusted requirements-docs.txt placement, integrated pylint, shellcheck, and sphinx validation, and minimized file changes for easier upstream merging. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #275 build(docs): incorporate the latest Sphinx Starter Pack | imagecraft | merged | Merged the latest Sphinx Starter Pack into the documentation build configuration. Approved by three reviewers. Initial CI failures on fast tests and builds were deemed unrelated by the maintainer, and the changes were successfully merged across 23 files. | |
| #136 docs: bring all starter pack documentation checks into docs lint | starbase | closed | Integrated Canonical Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into the documentation lint workflow. Resolved and merged via pull request #478. | |
| #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). | |
| #12 docs: Basic sphinx docs | starbase | merged | Merged basic Sphinx documentation adding 208 lines across 10 files. Approved by one reviewer and merged despite three unresolved comments. A noted test failure was resolved in PR #13. | |
| #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. | |
| #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. | |
| #478 build(docs): update Starter Pack and add passthrough to docs Makefile | starbase | merged | Merged after updating the Starter Pack and adding docs Makefile passthrough targets. Resolved CI warnings by removing sphinx-toolbox, fixed make docs-help failures, and incorporated reviewer feedback. Successfully integrated. | |
| #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. | |
| #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. | |
| #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. |