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

[docs] [developer] clarify M1 installation instructions #34505

Merged
merged 2 commits into from
Apr 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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