docs: refactor documentation for sphinx-starter-pack
Metadata
Current evaluation
Merged PR #300 in commit 66911e8e, refactoring 28 documentation files to align Rockcraft with sphinx-starter-pack and ease future integration.
Resolution: closed resolved
Reason: PR #300 was merged with three approvals as commit 66911e8e. The change reorganized the documentation structure and dependencies to match sphinx-starter-pack conventions.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #300 in commit 66911e8e, refactoring 28 documentation files to align Rockcraft with sphinx-starter-pack and ease future integration. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #300 as commit 66911e8e, refactoring 28 files to align Rockcraft’s documentation structure with sphinx-starter-pack and ease future integration. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #300 (66911e8e) refactored Rockcraft’s documentation structure for smoother integration with sphinx-starter-pack, changing 28 files (+351/−63). | |
| 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. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #559 docs: use canonical-sphinx | rockcraft | merged | Merged PR #559 (commit 041e3137) switched Rockcraft docs to canonical-sphinx, added the dependency to setup.cfg, and regenerated requirements-doc.txt. | |
| #979 chore: rename starter pack submodule | rockcraft | merged | Merged as c6c7879c, renaming the docs Starter Pack submodule to sphinx-docs-starter-pack and documenting contributor resync steps for Rockcraft 1.15. | |
| #900 build(docs): update build, add sphinx sitemap, update site links | rockcraft | merged | PR #900 merged as commit c1fea236 (ROCKCRAFT-237/238): updated the docs build, added sphinx-sitemap with the dirhtml builder, refreshed site links, and aligned local/CI docs tooling. | |
| #247 docs: include some docs from craft-parts | rockcraft | closed | PR pulling craft-parts docs into rockcraft was left unmerged and closed as redundant; the same docs refactor landed instead via rockcraft#515 (commit 5c2263f1, "refactor(docs): use more docs from craft-parts"). | |
| #720 docs: use canonical-sphinx | craft-parts | merged | Merged PR #720 as commit 278feb8d, migrating craft-parts docs to canonical-sphinx and removing legacy configuration across three files. | |
| #999 docs: release notes for 1.15.0 | rockcraft | merged | Merged #999, adding Rockcraft 1.15.0 release notes and documenting the sphinx-docs-starter-pack submodule rename; commit 319bb30a. | |
| #289 docs: expand rockcraft.yaml reference | rockcraft | merged | Merged into main via commit 654c9c01, reorganizing reference docs and expanding the rockcraft.yaml configuration reference across seven files. | |
| #2958 fix: update rockcraft documentation link to new url | charmcraft | merged | Merged PR #2958 updating legacy rockcraft documentation links from documentation.ubuntu.com to ubuntu.com/containers/rockcraft/docs across 10 files. | |
| #275 build(docs): incorporate the latest Sphinx Starter Pack | imagecraft | merged | Merged PR #275 (commit 097e5f5), refreshing the docs build with the latest canonical Sphinx Starter Pack across 23 files; author noted the failing fast-test/build checks were unrelated. | |
| #261 Update Sphinx starter pack | starbase | closed | Updated the Sphinx Starter Pack to 1.3.1 via merged PR #478, including docs Makefile passthrough targets so new projects inherit current documentation improvements and tests. |