Fix documentation build system branch handling #18
Conversation
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
This commit fixes how the documentation build system handles different branch types during sphinx-versioned multi-version builds. Changes: 1. conf.py: Fixed branch detection logic to properly distinguish between release branches (which have committed JSON snapshots) and all other branches (which use downloaded master JSON files). Also removed unused 'release' variable. 2. python_sphinx_docs.yml: Added comprehensive documentation explaining why JSON files are downloaded to master-tmp/ directory and how this supports multi-version documentation builds. The previous logic incorrectly assumed only the master branch should use downloaded files, causing development branches to fail when looking for non-existent committed files. Now all non-release branches correctly use the downloaded master JSON files.
blattms
approved these changes
Nov 25, 2025
Member
blattms
left a comment
blattms
left a comment
There was a problem hiding this comment.
I don't really know what I am doing 😬, but it looks good.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes how the documentation build system handles different branch types during sphinx-versioned multi-version builds.
The previous logic incorrectly assumed only the master branch should use downloaded files, causing development branches to fail when looking for non-existent committed files. Now all non-release branches correctly use the downloaded master JSON files.