Upgrade documentation environments to Sphinx 9 - #2599
Draft
aryanputta wants to merge 1 commit into
Draft
Conversation
Contributor
Contributor
Author
|
@mdboom I opened this draft PR for #2598. It updates the shared CI documentation environment from Sphinx <8.2.0 to Sphinx 9.x, along with the three component Pixi manifests and the local setup script. The local syntax and consistency checks pass; the full docs build is intended to run in CI because Pixi is not installed locally. Please let me know if you would like any changes, or if the team would prefer to handle this upgrade internally. Thanks! |
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
1 participant
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.
Summary
Motivation
Closes #2598. The repository currently constrains Sphinx to
<8.2.0, which prevents keeping the documentation toolchain current and can cause documented Sphinx directive syntax to drift from the installed version.This is separate from #2584, which fixes documentation defects rather than the dependency upgrade.
Validation
bash -n toolshed/setup-docs-env.shgit diff --checkPixi is not installed in the local environment, so the component documentation builds could not be run locally. CI should validate Sphinx 9.x compatibility across the documentation builds.