build(docs): update Sphinx Stack to 2.0
Metadata
Current evaluation
Closed unmerged; superseded by the Starbase synchronization merge commit 21f2ac7, which brought the Sphinx Stack 2.0 docs tooling changes into main.
Resolution: closed superseded
Reason: The PR was explicitly a preparation PR for the Starbase synchronization merge and was closed without merging; the changes landed via commit 21f2ac7 ('chore(merge): starbase into main').
Evaluated by: mr-cal-bot
No scores available.
Issue body
Migrate documentation tooling to Sphinx Stack 2.0:
- Move documentation development and lint tooling from `.sphinx` to `docs/_dev`.
- Update docs `Makefile` with Sphinx Stack 2.0 targets (`vale`, `pa11y`, etc).
- Update `conf.py` for Sphinx Stack 2.0 (sitemap, llms.txt, canonical theme).
- Add `explanation/documentation` page.
- Add `docs/requirements.txt`.
- Remove `mypy` and `pyright` from `lint-code` in `Makefile` in favor of `ty`.
### Provenance
- Upstreamed from Starbase commit [`fafd1fc`](https://github.com/canonical/starbase/commit/fafd1fc24a91ef0a5b3e451bd6328e97de999974)
- Originating Starbase PR: [canonical/starbase#537](https://github.com/canonical/starbase/pull/537).
*Note: This is a preparation PR opened in advance of the Starbase synchronization merge.*
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| ~deepseek/deepseek-pro-latest | — | closed superseded | Closed unmerged; superseded by the Starbase synchronization merge commit 21f2ac7, which brought the Sphinx Stack 2.0 docs tooling changes into main. | |
| ~deepseek/deepseek-pro-latest |
Impact:
30
Quick Win:
7
Complexity:
45
Confidence:
75
Actionability:
40
|
keep open | Migrates docs tooling to Sphinx Stack 2.0: moves .sphinx to docs/_dev, updates Makefile/conf.py, adds explanation page and docs/requirements.txt, replaces mypy/pyright with ty. CI failing OSV-scanner. |
Update history
| Date | Change |
|---|---|
| closed | |
| created |
Related work
-
Related To:
canonical/starbase#537
(confidence 80%)
Originating Starbase PR for the Sphinx Stack 2.0 changes that this preparation PR upstreamed.
-
Superseded By:
canonical/craft-cli@21f2ac7
(confidence 70%)
Starbase merge commit that landed the Sphinx Stack 2.0 docs tooling changes in main.
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. | |
| #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. | |
| #275 build(docs): upgrade to Sphinx Stack 2.0 | craft-platforms | closed | Merged as commit 75dff07, upgrading the documentation configuration and dependencies to Sphinx Stack 2.0 after all CI checks passed. | |
| #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. | |
| #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. | |
| #317 build(deps): update dependency canonical-sphinx to ~=0.3.0 | starbase | merged | Renovate PR merged: bumped canonical-sphinx from ~=0.2.0 to ~=0.3.0 in starbase's docs requirements, landing as commit 68ad84a. Later superseded by #420 which moved the pin to ~=0.5.1. | |
| #12 docs: Basic sphinx docs | starbase | merged | Merged in canonical/starbase#12 via commit 08a1e8d, adding basic Sphinx documentation with 208 lines 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. | |
| #4055 docs: import Sphinx scaffolding for documentation work | snapcraft | merged | Merged as commit ebc549ed4 ("docs: import Sphinx scaffolding for documentation work (#4055)"), adding Starbase-derived Sphinx docs scaffolding (docs/conf.py, tox docs config, 13 files, +513 lines). | |
| #504 build(deps): update dependency sphinx-sitemap to ==2.6.0 | starbase | merged | Merged in canonical/starbase#504 via commit 22b81ba, pinning sphinx-sitemap to 2.6.0 to prevent unintended sphinx-last-updated-by-git installation and fix the docs build. |