2017-02-27 21:14:31 -08:00
|
|
|
# Ray Documentation
|
|
|
|
|
|
|
|
To compile the documentation, run the following commands from this directory.
|
2017-03-01 23:34:44 -08:00
|
|
|
Note that Ray must be installed first.
|
2017-02-27 21:14:31 -08:00
|
|
|
|
|
|
|
```
|
|
|
|
pip install -r requirements-doc.txt
|
2020-09-15 12:51:18 -07:00
|
|
|
pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
|
2017-02-27 21:14:31 -08:00
|
|
|
make html
|
|
|
|
open _build/html/index.html
|
|
|
|
```
|
|
|
|
|
|
|
|
To test if there are any build errors with the documentation, do the following.
|
|
|
|
|
|
|
|
```
|
2020-06-05 15:40:30 +02:00
|
|
|
sphinx-build -b html -d _build/doctrees source _build/html
|
2017-02-27 21:14:31 -08:00
|
|
|
```
|