mirror of
https://github.com/vale981/ray
synced 2025-03-06 10:31:39 -05:00
065786b7fe
Signed-off-by: Jules S.Damji jules@anyscale.com Why are these changes needed? The code snippet referenced a python function that was not defined, therefore the code snippet as is won't work. All complete or self-contained code in our docs should run. The changes made were adding the undefined function, iterating over a list of different random large arrays to show the difference between local or distributed sort's execution time, and print them. Closes #20960 |
||
|---|---|---|
| .. | ||
| _build | ||
| azure | ||
| 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
To check if there are broken links, run the following (we are currently not running this in the CI since there are false positives).
make linkcheck