ray/doc
2019-12-16 23:57:42 -08:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
dev Bump version from 0.8.0.dev6 -> 0.9.0.dev (#6508) 2019-12-16 23:57:42 -08:00
examples Bump version from 0.8.0.dev6 -> 0.9.0.dev (#6508) 2019-12-16 23:57:42 -08:00
kubernetes Improve manual Kubernetes deployment documentation (#5582) 2019-10-03 15:47:49 -07:00
site [bug] Attempt to fix links not working. (#6390) 2019-12-07 14:31:50 -08:00
source Bump version from 0.8.0.dev6 -> 0.9.0.dev (#6508) 2019-12-16 23:57:42 -08:00
tools Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
yarn [docs] yarn update (#6173) 2019-11-19 16:15:08 -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 [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
README.md Only install ray python packages. (#330) 2017-03-01 23:34:44 -08:00
requirements-doc.txt [Serve] Added deadline awareness (#6442) 2019-12-11 16:41:54 -08: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