mirror of
https://github.com/wassname/ray.git
synced 2026-06-27 21:38:18 +08:00
architkulkarni
18 lines
464 B
Markdown
18 lines
464 B
Markdown
# Ray Documentation
|
|
|
|
To compile the documentation, run the following commands from this directory.
|
|
Note that Ray must be installed first.
|
|
|
|
```
|
|
pip install -r requirements-doc.txt
|
|
pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
|
|
make html
|
|
open _build/html/index.html
|
|
```
|
|
|
|
To test if there are any build errors with the documentation, do the following.
|
|
|
|
```
|
|
sphinx-build -b html -d _build/doctrees source _build/html
|
|
```
|