ray/doc
2020-05-30 22:48:34 +02: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 0.8.5 Release change. (#8358) 2020-05-28 09:37:19 -07:00
examples less important (#8439) 2020-05-13 22:52:38 -07:00
kubernetes Remove future imports (#6724) 2020-01-09 00:15:48 -08:00
site Replace all instances of ray.readthedocs.io with ray.io (#7994) 2020-04-13 16:17:05 -07:00
source [RLlib] Unity3D integration (n Unity3D clients vs learning server). (#8590) 2020-05-30 22:48:34 +02:00
tools Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
yarn Remove future imports (#6724) 2020-01-09 00:15:48 -08: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 Only install ray python packages. (#330) 2017-03-01 23:34:44 -08:00
requirements-doc.txt Set up testing and wheels for Windows on GitHub Actions (#8131) 2020-04-29 21:19:02 -07: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 -W -b html -d _build/doctrees source _build/html