[Docs] Have latest minor version sorted on the top in the version navigation window #46189
Assignees
Labels
docs
An issue or change related to documentation
enhancement
Request for new feature and/or capability
P1.5
Issues that will be fixed in a couple releases. It will be bumped once all P1s are cleared
Comments
GeneDer
added
enhancement
angelinalg
added
P1.5
|
cc: @peytondmurray |
8 tasks
can-anyscale
pushed a commit
that referenced
this issue
Aug 2, 2024
## 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]>
8 tasks
cristianjd
added a commit
that referenced
this issue
Aug 8, 2024
## 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]>
cristianjd
added a commit
that referenced
this issue
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 issue
Aug 8, 2024
## 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]>
cristianjd
added a commit
that referenced
this issue
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 issue
Aug 8, 2024
## 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]>
cristianjd
added a commit
that referenced
this issue
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 issue
Aug 8, 2024
## 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]>
cristianjd
added a commit
that referenced
this issue
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 issue
Aug 8, 2024
## 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]>
cristianjd
added a commit
that referenced
this issue
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
Description
Since we had 2 digit minor version, the sorting in the navigation window of the doc pages has been sorting the latest version in between their single digit counterparts instead of on the top. Would be nice to see for example 2.30.0 on the top of the window instead of seeing 2.9.3 on the top.
Use case
No response
The text was updated successfully, but these errors were encountered: