Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Fix minor glitch in installation docs #49079

Merged
merged 1 commit into from
Dec 4, 2024

Conversation

pcmoritz
Copy link
Contributor

@pcmoritz pcmoritz commented Dec 4, 2024

Why are these changes needed?

This fixes the empty "Note" box in https://docs.ray.io/en/latest/ray-overview/installation.html:

Screenshot 2024-12-04 at 12 09 28 PM

Related issue number

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 :(

@pcmoritz pcmoritz requested a review from a team as a code owner December 4, 2024 20:09
@@ -140,8 +140,6 @@ You can install the nightly Ray wheels via the following links. These daily rele

:ref:`Usage stats <ref-usage-stats>` collection is enabled by default (can be :ref:`disabled <usage-disable>`) for nightly wheels including both local clusters started via ``ray.init()`` and remote clusters via cli.

.. note::

.. If you change the list of wheel links below, remember to update `get_wheel_filename()` in `https://github.com/ray-project/ray/blob/master/python/ray/_private/utils.py`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps remove this line too, it doesn't show up (commented out?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this looks like a comment for people editing installation.rst and still seems relevant (in fact it seems this needs to be updated:

if py_version_str in ["311", "310", "39", "38"] and architecture == "arm64":
), so it is probably better to leave it :)

Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ty!

@pcmoritz pcmoritz enabled auto-merge (squash) December 4, 2024 21:22
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Dec 4, 2024
@pcmoritz pcmoritz merged commit 16e199e into master Dec 4, 2024
6 checks passed
@pcmoritz pcmoritz deleted the sphinx-fix-installation-note branch December 4, 2024 22:16
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Dec 17, 2024
<!-- 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?

This fixes the empty "Note" box in
https://docs.ray.io/en/latest/ray-overview/installation.html:

<img width="1481" alt="Screenshot 2024-12-04 at 12 09 28 PM"
src="https://github.com/user-attachments/assets/95f482a1-fa54-4048-a664-ec7e425469d6">

## Related issue number

<!-- For example: "Closes ray-project#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: ujjawal-khare <ujjawal.khare@dream11.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants