Use PyData Sphinx theme version switcher #46936
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
can-anyscale
reviewed
Aug 2, 2024
|
in the screen shot though, some versions (releases/2.33.0) are duplicated, are they intended? |
|
@can-anyscale good eyes. def not intended. will get a fix up |
Signed-off-by: cristianjd <[email protected]>
Signed-off-by: cristianjd <[email protected]>
cristianjd
force-pushed
the
cristian/version-switcher-pt-2
branch
from
2c80e26
to
72ae47e
Compare
|
Fixed duplicate versions issue by updating the JSON generation logic do not include tags with the JSON Before: JSON After: Note that the RTD build won't have this reflected since the build is pointing to the JSON from master |
Signed-off-by: cristianjd <[email protected]>
angelinalg
approved these changes
Aug 2, 2024
|
|
||
| /* Prevent the the PyData theme Version Switcher from getting too large */ | ||
| .version-switcher__menu { | ||
| max-height: 496px; |
There was a problem hiding this comment.
Might want to use a relative unit here so it scales with the user's font size.
| @@ -1261,6 +1261,7 @@ def pregenerate_example_rsts( | |||
| repo_url = "https://github.com/ray-project/ray.git" | |||
| static_dir_name = "_static" | |||
| version_json_filename = "versions.json" | |||
| dereference_suffix = "^{}" | |||
There was a problem hiding this comment.
I missed this change before - do we need these to be defined at the module level and not in the function that uses them? We really don't want to pollute the module namespace if we can avoid it, and as far as I can tell these are only being used in generate_versions_json.
There was a problem hiding this comment.
Will raise a follow up PR to address this since this one got merged. Thanks!
cristianjd
added a commit
that referenced
this pull request
Aug 8, 2024
## 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]>
cristianjd
added a commit
that referenced
this pull request
Aug 8, 2024
## 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]>
cristianjd
added a commit
that referenced
this pull request
Aug 8, 2024
## 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]>
cristianjd
added a commit
that referenced
this pull request
Aug 8, 2024
## 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]>
cristianjd
added a commit
that referenced
this pull request
Aug 8, 2024
## 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]>
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?
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.
versions.jsonand the selected version to theversionset by read the docsRelated issue number
Closes #46382
Closes #46189
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.