Adding documentation for building from current master without cloning. (

ray-project#1455) * Updating docs with pip way to build from source * wording
rongou · Jan 23, 2018 · 21a9160 · 21a9160
1 parent fb4d991
commit 21a9160
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/doc/source/install-on-macosx.rst b/doc/source/install-on-macosx.rst
@@ -48,6 +48,11 @@ Ray can be built from the repository as follows.
   cd ray/python
   python setup.py install  # Add --user if you see a permission denied error.
 
+Alternatively, Ray can be built from the repository without cloning using pip.
+
+.. code-block:: bash
+
+  pip install git+https://github.com/ray-project/ray.git#subdirectory=python
 
 Test if the installation succeeded
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/doc/source/install-on-ubuntu.rst b/doc/source/install-on-ubuntu.rst
@@ -56,6 +56,11 @@ Ray can be built from the repository as follows.
   cd ray/python
   python setup.py install  # Add --user if you see a permission denied error.
 
+Alternatively, Ray can be built from the repository without cloning using pip.
+
+.. code-block:: bash
+
+    pip install git+https://github.com/ray-project/ray.git#subdirectory=python
 
 Test if the installation succeeded
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~