Skip to content

build(docs): update Sphinx Stack to 2.0#537

Merged
jahn-junior merged 13 commits into
mainfrom
work/update-sphinx-stack/CRAFT-5162
Jun 2, 2026
Merged

build(docs): update Sphinx Stack to 2.0#537
jahn-junior merged 13 commits into
mainfrom
work/update-sphinx-stack/CRAFT-5162

Conversation

@jahn-junior
Copy link
Copy Markdown
Contributor

@jahn-junior jahn-junior commented May 27, 2026

  • Update docs tooling to Sphinx Stack 2.0 (see full diff).
  • Replace any other references to the 'Starter Pack'
  • Lock dependencies
  • Fix the autobuild loop by ignoring symlinks and generated dirs with SPHINX_AUTOBUILD_OPTS

  • I've followed the contribution guidelines.
  • I've signed the CLA.
    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 if one was missing.
    I've updated the relevant release notes.

Copilot AI review requested due to automatic review settings May 27, 2026 22:12
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the project’s documentation tooling/configuration to align with Canonical’s Sphinx Stack 2.0, including refreshed dependency sets and updated docs build/lint workflows.

Changes:

  • Updated Python dependency groups / lockfile to match Sphinx Stack 2.0 and related extensions.
  • Refactored docs build tooling (docs Makefile, _dev tooling, ignore patterns) and refreshed docs config (conf.py).
  • Replaced “Starter Pack” references with “Sphinx Stack” across docs.

Reviewed changes

Copilot reviewed 16 out of 20 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
uv.lock Locks new/updated docs toolchain dependencies required by Sphinx Stack 2.0.
pyproject.toml Renames/updates docs dependency group and aligns specifiers with Sphinx Stack 2.0.
docs/requirements.txt Updates docs subproject requirements to Sphinx Stack 2.0 extension set/versions.
docs/Makefile Updates docs dev/build targets and introduces SPHINX_AUTOBUILD_OPTS for autobuild behavior.
docs/conf.py Updates Sphinx configuration for Sphinx Stack 2.0 and enables new extensions/settings.
docs/_templates/header.html / docs/_templates/footer.html Adds theme template overrides for header/footer content.
docs/_dev/* Introduces/updates Sphinx Stack _dev tooling/config (Vale, pa11y, updater, version marker).
docs/README.md / docs/explanation/documentation.rst Updates documentation links and migration instructions to Sphinx Stack.
docs/.gitignore Adjusts ignored paths for new .venv and _dev layout.
common.mk Updates wording to reflect Sphinx Stack naming.
Comments suppressed due to low confidence (1)

docs/_dev/update_sp.py:25

  • SPHINX_UPDATE_DIR references DEV_DIR, but DEV_DIR is not defined anywhere in this script, so running the updater will raise NameError before doing any work. This should point at the local _dev directory (SPHINX_DIR).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/Makefile Outdated
Comment thread pyproject.toml
Comment thread docs/_templates/header.html
Comment thread docs/_templates/footer.html
@jahn-junior jahn-junior requested review from bepri and medubelko May 27, 2026 22:41
Copy link
Copy Markdown
Member

@bepri bepri left a comment

Choose a reason for hiding this comment

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

Below are comments that probably belong in the Sphinx Stack repository instead. Let me know if you want me to make these into issues over there.

Comment thread docs/conf.py
Comment thread docs/conf.py Outdated
Comment thread docs/conf.py Outdated
Comment thread pyproject.toml
jahn-junior and others added 3 commits May 29, 2026 13:23
Signed-off-by: JJ Coldiron <jj.coldiron@canonical.com>
Signed-off-by: JJ Coldiron <jj.coldiron@canonical.com>
Copy link
Copy Markdown
Contributor

@medubelko medubelko left a comment

Choose a reason for hiding this comment

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

The main commands tested fine locally. I added meta descriptions to all of the major indexes, because the link summaries in llms.txt were being truncated.

As an aside, it seems sphinx-llm can't process wrapped lines in .rst files, which is another reason to seriously consider moving away from wrapping.

Comment thread docs/conf.py
@jahn-junior jahn-junior merged commit fafd1fc into main Jun 2, 2026
10 of 11 checks passed
@jahn-junior jahn-junior deleted the work/update-sphinx-stack/CRAFT-5162 branch June 2, 2026 15:47
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.

5 participants