You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Docs] Add path-chooser, fix cross-references, and reorganize tips
- Remove combined opening tip (Python-only and Full build hints)
- Add path-chooser list at the top to direct readers to Python-only or
full source build paths
- Replace "as explained/described above" prose with :ref: cross-references
to fork-ray-repo and prepare-venv labels
- Move "if you already followed python-develop..." hint into a tip inside
the Full Source Build section
Topic: add-refs
Relative: update-wheel-docs
Signed-off-by: andrew <andrew@anyscale.com>
Copy file name to clipboardExpand all lines: doc/source/ray-contribute/development.rst
+12-8Lines changed: 12 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,10 @@ Building Ray from Source
5
5
6
6
To contribute to the Ray repository, follow the instructions below to build from the latest master branch.
7
7
8
-
.. tip::
9
-
10
-
If you are only editing Python files, follow instructions for :ref:`python-develop` to avoid long build times.
8
+
Depending on your goal, you may not need all sections on this page:
11
9
12
-
If you already followed the instructions in :ref:`python-develop` and want to switch to the Full build in this section, you will need to first uninstall.
10
+
- **Python-only development (fast loop, no C++)** - edit Python files without compiling C++. See :ref:`python-develop`.
11
+
- **Full source build (C++ + dashboard + editable install)** - make C++ changes or build all of Ray. See :ref:`full-source-build`.
13
12
14
13
.. contents::
15
14
:local:
@@ -93,9 +92,9 @@ Building Ray (Python Only)
93
92
94
93
RLlib, Tune, Autoscaler, and most Python files do not require you to build and compile Ray. Follow these instructions to develop Ray's Python files locally without building Ray.
95
94
96
-
1. Make sure you have a clone of Ray's git repository as explained above.
95
+
1. Make sure you have a clone of Ray's git repository (see :ref:`fork-ray-repo`).
97
96
98
-
2. Make sure you activate the Python (virtual) environment as described above.
97
+
2. Make sure you activate the Python (virtual) environment (see :ref:`prepare-venv`).
99
98
100
99
3. Pip install the **latest Ray wheels.** See :ref:`install-nightlies` for instructions.
101
100
@@ -133,6 +132,11 @@ RLlib, Tune, Autoscaler, and most Python files do not require you to build and c
133
132
Full Source Build
134
133
-----------------
135
134
135
+
.. tip::
136
+
137
+
If you already followed the instructions in :ref:`python-develop` and want to switch
138
+
to the Full build, you will need to first uninstall.
139
+
136
140
Preparing to build Ray on Linux
137
141
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138
142
@@ -185,7 +189,7 @@ To build Ray on MacOS, first install these dependencies:
185
189
Building Ray on Linux & MacOS (full)
186
190
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187
191
188
-
Make sure you have a local clone of Ray's git repository as explained above. You will also need to install NodeJS_ to build the dashboard.
192
+
Make sure you have a local clone of Ray's git repository (see :ref:`fork-ray-repo`). You will also need to install NodeJS_ to build the dashboard.
189
193
190
194
Enter into the project directory, for example:
191
195
@@ -213,7 +217,7 @@ After that, you can now move back to the top level Ray directory:
213
217
cd -
214
218
215
219
216
-
Now let's build Ray for Python. Make sure you activate any Python virtual (or conda) environment you could be using as described above.
220
+
Now let's build Ray for Python. Make sure you activate any Python virtual (or conda) environment (see :ref:`prepare-venv`).
217
221
218
222
Enter into the ``python/`` directory inside of the Ray project directory and install the project with ``pip``:
0 commit comments