Cristian/cherry pick version switcher 2.31.0 #47028
Merged
Conversation
This file contains 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
## Why are these changes needed? In order to move away from the "Read the Docs" version switcher and to the one provided by the PyData theme we must first have a stable JSON of the available versions as described here: https://github.com/google/google-java-format/releases/download/google-java-format-1.7/google-java-format-1.7-all-deps.jar The adds helpers to custom directives in order to get the list of git tags starting from the first one we display in the switcher then sort in semver order. "Latest" and "master" are added to the top. This is run in the setup fn to generate the JSON in the static folder. After this is deployed we can reference it, add the new picker, and hide the previous one. ## Related issue number This is part one of a fix for #46382 and #46189. The follow up will close these out. Signed-off-by: cristianjd <[email protected]>
## Why are these changes needed? This switches to using the PyData Sphinx theme version switcher so that we have more control of it's location and the ordering of the versions. - added the version switcher to the navbar - pointed the versions to the recently added `versions.json` and the selected version to the `version` set by read the docs - styling to limit the height of the version switcher and allow for scrolling to see more - styling to suppress the RTD version switcher <img width="646" alt="Screenshot 2024-08-02 at 10 46 45 AM" src="https://github.com/user-attachments/assets/00836b9f-5c2b-40ed-ab70-e0175ade8d0a"> ## Related issue number Closes #46382 Closes #46189 Signed-off-by: cristianjd <[email protected]>
## Why are these changes needed? A few small follow ups for the version switcher: - move constants to inside the versions JSON generation function - updated height of version switcher to be relative so it scales up with zoom level - changed `overflow` to `overflow-y` to stop the extra horizontal scroll from showing up Before:  After:  Signed-off-by: cristianjd <[email protected]>
Signed-off-by: cristianjd <[email protected]>
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.
Why are these changes needed?
Cherry picks the versions picker commits from master so it shows up in this older release version. Added missing subprocess import
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.