mirror of
https://github.com/vale981/ray
synced 2025-03-07 02:51:39 -05:00
e7aafd7d24
Co-authored-by: Sumanth Ratna <sumanthratna@gmail.com> Co-authored-by: Amog Kamsetty <amogkamsetty@yahoo.com> Co-authored-by: Amog Kamsetty <amogkam@users.noreply.github.com> Co-authored-by: Richard Liaw <rliaw@berkeley.edu> |
||
|---|---|---|
| .. | ||
| _build | ||
| azure | ||
| dev | ||
| examples | ||
| kubernetes | ||
| site | ||
| source | ||
| tools | ||
| yarn | ||
| .gitignore | ||
| BUILD | ||
| make.bat | ||
| Makefile | ||
| README.md | ||
| requirements-doc.txt | ||
| requirements-rtd.txt | ||
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