ray/doc
2018-07-07 14:34:20 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
source Update 0.4.0 to 0.5.0 in autoscaler and installation examples. (#2352) 2018-07-07 14:34:20 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile Move documentation to ReadTheDocs. (#326) 2017-02-27 21:14:31 -08:00
README.md Only install ray python packages. (#330) 2017-03-01 23:34:44 -08:00
requirements-doc.txt [xray] Add error table and push error messages to driver through node manager. (#2256) 2018-06-20 21:29:28 -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