Skip to content

Commit

Permalink
clarify M1 installation instructions (ray-project#34505)
Browse files Browse the repository at this point in the history
A few folks have been confused by the order of the installation instructions for M1, so adding some clarifying language. While I was at it, I made minor improvements to some language in nearby paragraphs.

Signed-off-by: elliottower <[email protected]>
  • Loading branch information
angelinalg authored and elliottower committed Apr 22, 2023
1 parent 1df0ca1 commit 6eb23c7
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions doc/source/ray-contribute/docs.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -28,28 +28,27 @@
"cd ray/doc\n",
"```\n",
"\n",
"**Note**: If you are on an Apple Silicon (M1) read the instructions below for installing the dependencies.\n",
"**Note**: If you are using Apple Silicon (M1), follow the instructions below before continuing.\n",
"\n",
"Make sure you activate the Python environment you are using (e.g. venv, conda, etc.) and then to install the documentation dependencies, run the following command:\n",
"Activate the Python environment you are using (e.g., venv, conda, etc.). Install the documentation dependencies, with the following command:\n",
"\n",
"```shell\n",
"pip install -r requirements-doc.txt\n",
"```\n",
"\n",
"Additionally, it's best if you install the dependencies for our linters with\n",
"Install the dependencies for our linters to ensure your changes comply with our style guide.\n",
"\n",
"```shell\n",
"pip install -r ../python/requirements_linters.txt\n",
"```\n",
"\n",
"so that you can make sure your changes comply with our style guide.\n",
"Building the documentation is done by running the following command:\n",
"Build the documentation by running the following command:\n",
"\n",
"```shell\n",
"make develop\n",
"```\n",
"\n",
"which will build the documentation into the `_build` directory.\n",
"Find the documentation build in the `_build` directory.\n",
"After the build finishes, you can simply open the `_build/html/index.html` file in your browser.\n",
"It's considered good practice to check the output of your build to make sure everything is working as expected.\n",
"\n",
Expand Down

0 comments on commit 6eb23c7

Please sign in to comment.