Skip to content

build(docs): update Sphinx Stack to 2.0 - #497

Open
lengau wants to merge 3 commits into
mainfrom
work/bot/migrate-docs-sphinx-stack
Open

lengau wants to merge 3 commits into
mainfrom
work/bot/migrate-docs-sphinx-stack

Conversation

@lengau

@lengau lengau commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

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 regenerate lockfile.
  • Ignore docs/_dev in .prettierignore.

Provenance

Note: This is a preparation PR opened in advance of the Starbase synchronization merge.

Copilot AI lite review requested due to automatic review settings October 9, 2026 03:46
@lengau
lengau force-pushed the work/bot/migrate-docs-sphinx-stack branch from c999a66 to d907068 Compare October 9, 2026 03:50

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Critical Read the Docs and dependency-lock issues, along with failing Make targets, remain unresolved.

8 open findings
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.

Comment thread .readthedocs.yaml
Comment thread docs/Makefile
Comment thread pyproject.toml
Comment thread docs/Makefile
Comment thread docs/Makefile
Comment thread docs/conf.py
Comment thread docs/README.md
Comment thread docs/README.md
@lengau
lengau marked this pull request as ready for review October 9, 2026 17:08
@lengau
lengau requested review from a team and bepri as code owners October 9, 2026 17:08

@jahn-junior jahn-junior left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor things, but no need for another review from me. Thanks!

Comment thread docs/explanation/documentation.rst Outdated
Comment thread docs/explanation/index.rst Outdated
Comment thread docs/conf.py Outdated
lengau and others added 3 commits October 9, 2026 14:10
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
lengau force-pushed the work/bot/migrate-docs-sphinx-stack branch from 4eb6f29 to 2cb746c Compare October 9, 2026 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants