← Back to issue list

docs: update dependency sphinx stack to 2.0

View original Github issue

Metadata

Project
rockcraft
Number
#1252
Type
pull request
State
merged
Author
asanvaq
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: PR #1252 was merged into main as commit caf0486f, implementing the Sphinx Stack 2.0 upgrade and related documentation tooling changes. Reported build trouble was attributed to intermittent network load rather than abandonment of the PR.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- Update docs tooling to Sphinx Stack 2.0 ([see full diff](https://github.com/canonical/sphinx-stack/compare/1.5...2.0)). - Replace any other references to the 'Starter Pack' - Lock dependencies - Ignore the docs/_dev/ directory when running the Sphinx linter - Configure the link checker to use the more modern timeout reporting --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/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`. - [ ] I've added or updated any relevant documentation. - [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged PR #1252 as commit caf0486f, upgrading and locking docs tooling to Sphinx Stack 2.0, removing Starter Pack references, and adjusting linter/link-checker settings.
qwen/qwen3.6-35b-a3b — — Merged. Updates docs tooling to Sphinx Stack 2.0, replaces Starter Pack references, locks dependencies, and adjusts linter and link checker settings. Initial CI failures from external links and network issues were resolved prior to merge.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/rockcraft#1274 (confidence 75%)

    Follow-up PR ae356932 updated intersphinx paths after documentation URLs migrated.

Related issues

Issue Project State Summary Similarity
#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.
84%
#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.
84%
#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.
82%
#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.
80%
#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.
78%
#229 build(deps): update dependency sphinx-lint to v1 craft-store merged Merged PR #229 upgraded sphinx-lint from 0.9.1 to 1.0.0 in commit 65cc856, updating two dependency files.
74%
#660 build(deps): update dependency sphinx-lint to v1 craft-providers merged Renovate PR #660 was merged, updating sphinx-lint from 0.9.1 to 1.0.0; the change landed in commits 7494548 and abb814b.
73%
#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.
73%
#73 docs: update sphinx to 6 starbase merged Merged via f4f5541, updating the documentation dependency to Sphinx 6 as an intermediate step; Furo#653 still blocked Sphinx 7.
72%
#233 build(deps): update dependency sphinx to v8.1.3 craft-store merged Merged PR #233 upgraded Sphinx from 8.0.2 to 8.1.3 in two dependency files via commit 4519f1a.
72%