hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-06 10:31:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ray/doc
History
Richard Liaw 7f4141df4e
[docs] Pictures for all the Examples (#5859) 
* image

* plot resnet

* hyperparam

* fixup_pictures

* custom_direct
2019-10-14 14:18:52 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
dev Release 0.7.5 updates (#5727) 2019-09-26 10:30:37 -07:00
examples [docs] Pictures for all the Examples (#5859) 2019-10-14 14:18:52 -07:00
kubernetes Improve manual Kubernetes deployment documentation (#5582) 2019-10-03 15:47:49 -07:00
site Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
source [docs] Pictures for all the Examples (#5859) 2019-10-14 14:18:52 -07:00
tools Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -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 [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 [tune] Readable trial progress output (#5822) 2019-10-08 16:38:39 -07:00

README.md

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