Repository navigation
Conversation
lengau
force-pushed
the
work/bot/migrate-docs-sphinx-stack
branch
from
October 9, 2026 03:50
c999a66 to
d907068
Compare
There was a problem hiding this comment.
🟡 Changes recommended
Critical Read the Docs and dependency-lock issues, along with failing Make targets, remain unresolved.
8 open findings
Docs build ignores the Read the Docs output directory · New Trailing backslash breaks pdf-prep-force · New uv.lock resolves canonical-sphinx outside the required version range · New PA11Y_CMD causes redundant npm installations · New Vale failures are masked by the vocabulary restore command · New Custom Sphinx templates are not configured · New Documentation references nonexistent docs-setup target · New Documentation references nonexistent docs-lint target · New
What changed in this PR
Migrates documentation tooling to Sphinx Stack 2.0, including updated dependencies, build targets, configuration, templates, and documentation guidance.
Changes:
- Moves development tooling into
docs/_dev. - Adds Sphinx Stack dependencies and documentation requirements.
- Updates Make targets, Sphinx configuration, templates, and Read the Docs setup.
- Adds documentation process guidance and linting/accessibility tooling.
| File | Summary |
|---|---|
uv.lock |
Updates documentation dependency resolution. |
pyproject.toml |
Adds the Sphinx Stack dependency group. |
docs/requirements.txt |
Defines standalone documentation dependencies. |
docs/README.md |
Documents documentation tooling workflows. |
docs/Makefile |
Adds build, lint, Vale, and accessibility targets. |
docs/index.rst |
Updates documentation navigation. |
docs/explanation/index.rst |
Adds the explanation page to navigation. |
docs/explanation/documentation.rst |
Adds documentation guidance. |
docs/conf.py |
Updates Sphinx Stack configuration. |
docs/.gitignore |
Ignores generated tooling files. |
docs/.custom_wordlist.txt |
Expands documentation vocabulary. |
docs/_templates/header.html |
Adds the custom header template. |
docs/_templates/footer.html |
Adds the custom footer template. |
docs/_dev/version |
Records Sphinx Stack version 2.0. |
docs/_dev/update_sp.py |
Adds Sphinx Stack update tooling. |
docs/_dev/pa11y.json |
Configures accessibility checks. |
docs/_dev/get_vale_conf.py |
Fetches Vale configuration. |
docs/_dev/.pymarkdown.json |
Configures Markdown linting. |
docs/_dev/.pre-commit-config.yaml |
Defines documentation hooks. |
.readthedocs.yaml |
Configures the Read the Docs environment and build. |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
lengau
marked this pull request as ready for review
October 9, 2026 17:08
jahn-junior
approved these changes
Oct 9, 2026
jahn-junior
left a comment
Contributor
There was a problem hiding this comment.
A few minor things, but no need for another review from me. Thanks!
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. - Adopt docs-sphinx-stack dependency group in pyproject.toml and lock. - Ignore docs/_dev in .prettierignore. - Add docs targets and environment variables to common.mk and Makefile. - Update .readthedocs.yaml to build docs using Sphinx Stack 2.0 targets. Upstreamed from Starbase commit fafd1fc (canonical/starbase@fafd1fc) and Starbase PR #537 (canonical/starbase#537).
Co-authored-by: JJ Coldiron <jj.coldiron@canonical.com> Signed-off-by: Alex Lowe <alex.lowe@canonical.com>
lengau
force-pushed
the
work/bot/migrate-docs-sphinx-stack
branch
from
October 9, 2026 18:12
4eb6f29 to
2cb746c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Migrate documentation tooling to Sphinx Stack 2.0:
.sphinxtodocs/_dev.Makefilewith Sphinx Stack 2.0 targets (vale,pa11y, etc).conf.pyfor Sphinx Stack 2.0 (sitemap, llms.txt, canonical theme).explanation/documentationpage.docs/requirements.txt.docs-sphinx-stackdependency group inpyproject.tomland regenerate lockfile.docs/_devin.prettierignore.Provenance
fafd1fcNote: This is a preparation PR opened in advance of the Starbase synchronization merge.