build(docs): incorporate the latest Sphinx Starter Pack
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged to incorporate the latest Sphinx Starter Pack, aligning with similar updates across Canonical repositories. Initial test failures were assessed as unrelated and did not block the merge. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #1112 build(docs): refresh starter pack implementation | rockcraft | merged | Merged an external contribution refreshing the documentation starter pack. The update integrates the latest upstream pack, adds a project-specific wordlist, and documents new make commands for building and linting. Approved by two reviewers and passed CI checks. | |
| #4367 docs: update sphinx theme | snapcraft | merged | Merged documentation update for the Sphinx theme. Initial build failures were resolved by incorporating fixes from PR #4375 and minor adjustments. Approved by three reviewers, passed CI, and merged into main. | |
| #261 Update Sphinx starter pack | starbase | closed | Updated the Sphinx starter pack to the latest version. The request was resolved and merged via pull request #478, enabling all projects to inherit recent improvements and tests. | |
| #1070 build(docs)!: add dependency starter pack 1.5 | craft-application | merged | Merged after three approvals and passing all CI checks. Adds dependency starter pack 1.5 to fix documentation-only pull request build failures, updating 44 files with 1823 additions and 337 deletions. | |
| #537 build(docs): update Sphinx Stack to 2.0 | starbase | merged | Merged after three reviewer approvals. Updates documentation tooling to Sphinx Stack 2.0, locks dependencies, replaces legacy references, and resolves an autobuild loop by configuring Sphinx AutoBuild to ignore symlinks and generated directories. | |
| #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. | |
| #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. | |
| #131 ci: check for changes to docs in linters and tests | starflow | merged | Merged. Updates CI to detect documentation changes in linters and tests, and upgrades to Starter Pack 1.5. Approved by two reviewers with all continuous integration checks passing across multiple platforms. |