ray/doc
2020-09-29 14:48:39 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
azure [docs] redis-port -> port (#10937) 2020-09-23 17:04:13 -07:00
dev [Placement group] Release test (#10924) 2020-09-22 00:49:04 -07:00
examples [docs] redis-port -> port (#10937) 2020-09-23 17:04:13 -07:00
kubernetes [docs] redis-port -> port (#10937) 2020-09-23 17:04:13 -07:00
site [1.0] Simple, universal instead of Simple and universal (#10587) 2020-09-04 14:04:29 -07:00
source [tune] add faq entry for reproducing experiments (setting seeds etc) (#11106) 2020-09-29 14:48:39 -07:00
tools Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
yarn [docs] redis-port -> port (#10937) 2020-09-23 17:04:13 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
BUILD [docs] slurm + progress_bar example (#10782) 2020-09-15 00:16:36 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile [tune] New Doc edits, add Concepts page (#8083) 2020-04-25 18:25:56 -07:00
README.md [Docs] update docs readme and fix typo (#10807) 2020-09-15 12:51:18 -07:00
requirements-doc.txt [tune] add mode/metric parameters to tune.run (#10627) 2020-09-08 17:06:21 -07:00
requirements-rtd.txt [docs] Polish community integrations docs (#10780) 2020-09-14 14:41:06 -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