build(docs): upgrade to Sphinx Stack 2.0
Metadata
Current evaluation
Merged as commit 75dff07, upgrading the documentation configuration and dependencies to Sphinx Stack 2.0 after all CI checks passed.
Resolution: closed resolved
Reason: Commit 75dff07 is titled "build(docs): upgrade to Sphinx Stack 2.0 (#275)" and updates docs/conf.py, pyproject.toml, and uv.lock. The final PR comment records 8a45193 as the merge-conflict resolution, with no failing or pending CI checks.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Upgrades `docs/conf.py` and the docs dependency stack to Starbase's current 'Sphinx Stack 2.0' template, extracted ahead of the broader Starbase merge (#270) since it's a large, independently-mergeable, template-derived change.
## What's changing
- `canonical-sphinx[full]~=0.2` -> `canonical-sphinx~=0.6` (extensions it used to bundle via the `[full]` extra are now declared explicitly).
- New `docs-sphinx-stack` dependency group (sphinx-design, sphinx-notfound-page, sphinx-rerediraffe, sphinx-sitemap, sphinx-llm, sphinx-related-links, sphinx-roles, sphinx-terminal, sphinxcontrib-jquery, sphinxext-opengraph, vale, etc.), scoped to `python>=3.10` since `canonical-sphinx>=0.6` requires it.
- `docs/conf.py` rewritten to match: sitemap config, redirects (`docs/redirects.txt`, new, currently empty), llms.txt generation config, updated `html_context`/theme options, new extensions list.
- Dropped the dead `sphinx-toolbox.github` config (`github_username`/`github_repository`) — also removed independently in #274.
- Kept `explanation/index.rst` in `exclude_patterns`, since this PR intentionally doesn't touch `docs/index.rst`'s toctree structure (that's part of the wider Starbase docs restructuring in #270).
- `uv.lock` regenerated (kept the existing file as a base rather than deleting it, to avoid unrelated floating-dependency drift).
## Validation
Ran `make format`, `make lint-docs`, `make docs`, `make test-fast` — all green, using a fresh isolated venv sync to match what a clean CI checkout produces.
🤖 [BEEP BOOP, A BOT WROTE THIS COMMENT - Claude Sonnet 5, GitHub Copilot CLI]
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged as commit 75dff07, upgrading the documentation configuration and dependencies to Sphinx Stack 2.0 after all CI checks passed. | |
| stealth/space-bunny-alpha | — | closed stale | Sphinx Stack 2.0 docs upgrade closed unmerged despite passing CI; commit 8a45193 only merged main to resolve conflicts. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
17
Complexity:
25
Confidence:
75
Actionability:
75
|
needs review | Upgrades docs dependency stack to Sphinx Stack 2.0, extracted from Starbase merge #270. All CI passing, awaiting review with 2 unresolved automated comments. |
Update history
| Date | Change |
|---|---|
| closed | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| created |
Related work
-
Related To:
canonical/craft-platforms#270
(confidence 95%)
The broader Starbase merge from which this independently mergeable docs update was extracted.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #497 build(docs): update Sphinx Stack to 2.0 | craft-cli | merged | Merged PR updating documentation tooling to Sphinx Stack 2.0, migrating from .sphinx to docs/_dev, updating conf.py and Makefile, and adding new documentation files. Upstreamed from canonical/starbase#537. | |
| #1215 build(docs): update Sphinx Stack to 2.0 | craft-application | merged | Merged PR migrating docs tooling to Sphinx Stack 2.0: renames .sphinx to _dev, docs-starter-pack to docs-sphinx-stack, switches to sphinx_rerediraffe, adds sphinx-llm and templates. | |
| #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. | |
| #496 build(docs): update Sphinx Stack to 2.0 | craft-cli | closed | Closed unmerged; superseded by the Starbase synchronization merge commit 21f2ac7, which brought the Sphinx Stack 2.0 docs tooling changes into main. | |
| #1252 docs: update dependency sphinx stack to 2.0 | rockcraft | merged | Merged PR #1252 as caf0486f, upgrading and locking docs tooling to Sphinx Stack 2.0, removing Starter Pack references, and updating linter/link-checker settings. | |
| #554 docs: update docs subproject readme | starbase | merged | PR #554 by medubelko merged as commit 0b67b94, rewriting docs/README.md with corrected, more detailed steps for updating the docs (Sphinx Stack) subproject; approved by 2 reviewers, all CI green. | |
| #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. | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. | |
| #501 docs: update Sphinx theme | craft-parts | merged | Merged as ed49f727, updating the Sphinx theme and documentation configuration; follow-up #502 (fd11dddc) repaired tox documentation builds. |