ray/doc
2020-03-09 16:03:56 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
azure [autoscaler] azure init script path (#7515) 2020-03-09 09:49:07 -07:00
dev Improve release process from 0.8.2 (#7303) 2020-02-24 21:18:53 -08:00
examples [RaySGD] Rename PyTorch API endpoints to start with Torch (#7425) 2020-03-03 16:44:42 -08:00
kubernetes Remove future imports (#6724) 2020-01-09 00:15:48 -08:00
site [bug] Attempt to fix links not working. (#6390) 2019-12-07 14:31:50 -08:00
source added Azure Resource Manager (ARM) template (#7494) 2020-03-08 22:29:10 -07: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 Improved contributor instructions (#7026) 2020-02-04 14:07:51 -08:00
README.md Only install ray python packages. (#330) 2017-03-01 23:34:44 -08:00
requirements-doc.txt Deprecate use_pickle flag (#7474) 2020-03-09 16:03:56 -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