build(docs): update Sphinx Stack to 2.0
Metadata
Current evaluation
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.
Suggested action: —
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
* Fix the autobuild loop by ignoring symlinks and generated dirs with `SPHINX_AUTOBUILD_OPTS`
---
- [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/).
~~I've successfully run `make lint && make test`.~~
- [x] 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 |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Updated documentation tooling to Sphinx Stack 2.0, replaced Starter Pack references, locked dependencies, and resolved the autobuild loop by ignoring symlinks and generated directories. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1252 docs: update dependency sphinx stack to 2.0 | rockcraft | merged | 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. | |
| #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. | |
| #2323 build(docs): add sphinx sitemap | charmcraft | merged | Merged following approval from two reviewers. Integrated sphinx-sitemap as a documentation dependency, updated conf.py to generate a sitemap during builds, and switched local builds to the dirhtml builder. | |
| #900 build(docs): update build, add sphinx sitemap, update site links | rockcraft | merged | Merged after two approvals and passing all CI checks. Updates docs build config, switches Sphinx to dirhtml for sitemap generation, adds a sitemap, updates site links, and standardizes tooling across five files. | |
| #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. | |
| #4128 docs: set sphinx autobuild-docs to watch the correct directories | snapcraft | merged | Merged into main after two approvals and passing CI. Updates Sphinx autodoc configuration to monitor the correct directories, resolving issue #4123. Code coverage remained unchanged. | |
| #163 docs: use Sphinx + Readthedocs | fetch-service | merged | Merged documentation migration to Sphinx using the canonical-sphinx extension and integrated ReadTheDocs for automated builds. Approved by two reviewers, modifying eight files with 206 additions and 102 deletions. |