← Back to issue list

build(docs): incorporate the latest Sphinx Starter Pack

View original Github issue

Metadata

Project
imagecraft
Number
#275
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: The PR was approved by 3 reviewers and merged into main as commit 097e5f5 ("build(docs): incorporate the latest Sphinx Starter Pack (#275)"), completing the Starter Pack update that later moved on to Starter Pack 1.5 (#499).

Evaluated by: mr-cal-bot

No scores available.

Issue body

Incorporates the latest version of the [Sphinx Starter Pack](https://github.com/canonical/sphinx-docs-starter-pack). Introduces similar changes to canonical/starbase#478 and canonical/snapcraft#6037. --- - [X] I've followed the [contribution guidelines](https://github.com/canonical/imagecraft/blob/main/CONTRIBUTING.md). - [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [X] I've successfully run `make lint && make test`. - [X] I've added or updated any relevant documentation.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged the latest Sphinx Starter Pack into the documentation build in PR #275 (commit 097e5f5), changing 23 files.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged the update to incorporate the latest Sphinx Starter Pack for documentation builds. The author clarified that recent test failures were unrelated. Changes passed lint and test checks before being merged.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/starbase#478 (confidence 85%)

    Cited in the PR body as the equivalent upstream change mirrored in imagecraft.

  • Related To: canonical/snapcraft#6037 (confidence 80%)

    Cited in the PR body as the parallel change in the snapcraft project.

  • Related To: canonical/imagecraft#499 (confidence 55%)

    Follow-up commit 8c01792 "build(docs): upgrade Starter Pack to 1.5" supersedes this Starter Pack refresh.

Related issues

Issue Project State Summary Similarity
#1112 build(docs): refresh starter pack implementation rockcraft merged Merged in PR #1112 via commit 61e6bf3a, refreshing the docs starter pack, adding a wordlist, local docs-auto serving, and docs-lint coverage.
79%
#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.
79%
#537 build(docs): update Sphinx Stack to 2.0 starbase merged Merged in canonical/starbase#537 (commit fafd1fc), upgrading docs to Sphinx Stack 2.0, locking dependencies, removing Starter Pack references, and stopping autobuild loops.
77%
#6037 build(docs): refresh starter pack implementation snapcraft merged Merged PR #6037 (commit 4ee7c7e9f) refreshed Snapcraft's documentation starter pack to 1.4.0 across 73 files, resolving #5071; approvals and all CI checks passed.
75%
#1070 build(docs)!: add dependency starter pack 1.5 craft-application merged Merged PR #1070 added dependency starter pack 1.5 to fix docs-only PR builds, landing as commit 691eec7e with all CI checks passing.
74%
#478 build(docs): update Starter Pack and add passthrough to docs Makefile starbase merged Merged #478 as e94f190, updating the Starter Pack docs build and adding root Make aliases plus docs-* passthrough targets.
74%
#1482 build(docs): refresh starter pack implementation craft-parts merged Maintainer medubelko merged PR #1482 bumping the docs to Starter Pack 1.4.0 (+1371/-1094 across 35 files), resolving the `details` directive issue #1454 and CRAFT-5015.
73%
#713 docs: remove starter pack submodule craft-providers merged Merged docs cleanup PR deleting the leftover sphinx-docs-starter-pack submodule directory (and its .gitmodules entry) left behind after #562 removed the submodule, avoiding pip build errors.
73%
#562 docs: update to canonical-sphinx craft-providers merged Merged PR (commit 9897239) enabled the canonical-sphinx docs extension and removed sphinx-docs-starter-pack submodule references in craft-providers. Leftover submodule dir was later cleaned up in #713.
73%
#300 docs: refactor documentation for sphinx-starter-pack rockcraft merged Merged PR #300 in commit 66911e8e, refactoring 28 documentation files to align Rockcraft with sphinx-starter-pack and ease future integration.
72%