[docs] fix version picker selected version #50292
Merged
+2
−4
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
Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
aslonnie
reviewed
Feb 10, 2025
aslonnie
approved these changes
Feb 10, 2025
Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
cristianjd
added a commit
that referenced
this pull request
Feb 11, 2025
## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
16 tasks
cristianjd
added a commit
that referenced
this pull request
Feb 11, 2025
## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
8 tasks
cristianjd
added a commit
that referenced
this pull request
Feb 11, 2025
## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
8 tasks
cristianjd
added a commit
that referenced
this pull request
Feb 11, 2025
## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
8 tasks
cristianjd
added a commit
that referenced
this pull request
Feb 11, 2025
## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
8 tasks
cristianjd
added a commit
that referenced
this pull request
Feb 11, 2025
## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
8 tasks
cristianjd
added a commit
that referenced
this pull request
Feb 11, 2025
## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
8 tasks
cristianjd
added a commit
that referenced
this pull request
Feb 11, 2025
## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
8 tasks
pcmoritz
pushed a commit
that referenced
this pull request
Feb 11, 2025
This cherry picks #50292 to release 2.42.0 so the version picker correctly respects the selected version ## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- <!-- Thank you for your contribution! Please review https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst before opening a pull request. --> <!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. --> ## Why are these changes needed? <!-- Please give a short summary of the change and the problem this solves. --> ## Related issue number <!-- For example: "Closes #1234" --> ## Checks - [ ] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [ ] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
pcmoritz
pushed a commit
that referenced
this pull request
Feb 11, 2025
Cherry picks the following PRs to version 2.41.0 to fix version switcher issues #49892 #50292 ## Checks - [ ] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [ ] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
cristianjd
added a commit
that referenced
this pull request
Feb 12, 2025
## Why are these changes needed? The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect. Fixed by updating the json generation logic to use versions of the form `releases-2.42.0` instead `releases/2.24.0` and updated the version match logic in `conf.py` back to just reading the version directly Before:  After:  ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
8 tasks
pcmoritz
pushed a commit
that referenced
this pull request
Feb 12, 2025
This cherry picks #50292 to release 2.42.1 so the version picker correctly respects the selected version ## Checks - [ ] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [ ] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
pcmoritz
pushed a commit
that referenced
this pull request
Feb 13, 2025
Cherry picks the following PRs to version 2.39.0 to fix version switcher issues #49892 #50292 ## Checks - [ ] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [ ] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: cristianjd <cristian.j.derr@gmail.com>
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?
The version picker was not properly respecting the selected version. This is due to the generated versions in the json being incorrect.
Fixed by updating the json generation logic to use versions of the form
releases-2.42.0insteadreleases/2.24.0and updated the version match logic inconf.pyback to just reading the version directlyBefore:
After:
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.