ray/doc
2021-09-08 10:09:01 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
azure [autoscaler] Azure deployment fixes (#11613) 2020-10-27 15:27:18 -07:00
examples Update streaming example to use wait 2021-07-30 16:14:30 -07:00
kubernetes [client][docs] update docs for new client support in init (#17333) 2021-08-04 05:31:44 +03:00
site [docs] Move all /latest links to /master (#11897) 2020-11-10 10:53:28 -08:00
source [Datasets] Adds tensor column support (tensors-in-tables) via Pandas/Arrow extension types/arrays. (#18301) 2021-09-08 10:09:01 -07:00
tools Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
yarn [core] Deprecate QuotaAwareEvictionPolicy (#16911) 2021-07-07 13:44:41 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
BUILD [CI] Add test owners (#17893) 2021-08-18 18:38:31 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile Treat doc warnings as errors in Makefile to mirror CI linter (#14917) 2021-03-29 15:18:22 -07:00
README.md [Docs] update docs readme and fix typo (#10807) 2020-09-15 12:51:18 -07:00
requirements-doc.txt PyTorch Lightning Updates (#17876) 2021-08-27 23:15:51 -07:00
requirements-rtd.txt Revert "[docs] readthedocs.yaml and remove requirements-rtd.txt (#16482)" (#16512) 2021-06-17 11:50:30 -07:00

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