build(docs): update Starter Pack and add passthrough to docs Makefile
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
Add aliases and passthrough Make targets provided by the docs project. With this, you can run make at the root of the project and access docs commands. The behaviour is:
- `docs` safely calls `html`
- `docs-auto` safely calls `serve`
- `docs-clean` safely calls `clean`
- `docs-install` calls `vale-install` and then calls root `setup-docs`
- `docs-*` passes through to all other doc targets
The goal is to keep the docs build nearly unedited. For this to work as of Starter Pack 1.3.1, the `VALEDIR` var in the docs Makefile must be changed to a conditional assignment (`?=`).
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/starbase/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 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after updating the Starter Pack and adding docs Makefile passthrough targets. CI failures were resolved by removing sphinx-toolbox and fixing make docs-help errors. Reviewer feedback was addressed prior to final approval. |
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. | |
| #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. | |
| #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. | |
| #6037 build(docs): refresh starter pack implementation | snapcraft | merged | Merged. Refreshed the documentation starter pack across 73 files, re-integrating the latest version. Kept templates for GA enablement per feedback. Passed CI, approved by three reviewers, and fixes #5071. | |
| #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. | |
| #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. | |
| #499 build(docs): upgrade Starter Pack to 1.5 | starbase | merged | Merged the Starter Pack upgrade to version 1.5. Approved by two reviewers and passed all CI checks. Modified 12 files (+114/-459 lines). Resolves CRAFT-5035. | |
| #523 docs: update Starter Pack variables | starbase | merged | Merged documentation update correcting Starter Pack variables previously missed in PR #499. Scope limited to variable name fixes only, deferring the autobuild issue to a separate upstream fix. Approved by two reviewers and passed CI checks. | |
| #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. | |
| #1482 build(docs): refresh starter pack implementation | craft-parts | merged | Merged update refreshing the starter pack implementation to version 1.4.0. Resolves #1454 and fixes CRAFT-5015. The change modifies 35 files, passes all CI checks, and received dual reviewer approval before being merged. |