ray/doc
2020-06-22 14:49:16 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
azure Azure Portal cluster deployment | Support spot instances (#7558) 2020-03-11 18:46:11 -07:00
dev [Testing] Multi-node Training+Tune Long Running Test (#8966) 2020-06-22 14:49:16 -07:00
examples less important (#8439) 2020-05-13 22:52:38 -07:00
kubernetes Change os.uname()[1] and socket.gethostname() to the portable and faster platform.node_ip() (#8839) 2020-06-08 21:29:46 -07:00
site Replace all instances of ray.readthedocs.io with ray.io (#7994) 2020-04-13 16:17:05 -07:00
source [Dashboard] Update the Ray dashboard documentation to explain memory view. (#8945) 2020-06-22 13:50:32 -05:00
tools Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
yarn Change os.uname()[1] and socket.gethostname() to the portable and faster platform.node_ip() (#8839) 2020-06-08 21:29:46 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -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 [RLlib] Fix use_lstm flag for ModelV2 (w/o ModelV1 wrapping) and add it for PyTorch. (#8734) 2020-06-05 15:40:30 +02:00
requirements-doc.txt [Testing] Fix LINT/sphinx errors. (#8874) 2020-06-10 15:41:59 +02:00
requirements-rtd.txt [docs] Fix readthedocs rendering (#7810) 2020-03-30 11:40:08 -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
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