ray/doc
Edward Oakes 8ca7fab581
Improve manual Kubernetes deployment documentation (#5582)
* Add ray-cluster, modify submit

* Add comments

* Job submission working

* Write docs

* Add link to autoscaling

* Fix wget link in job

* Use namespace file

* match tense

* fix tab

* Improve job documentation

* comments

* Fix link

* Fix links

* comments

* add overview paragraph

* Update imagePullPolicy

* Warning if no cluster running

* better check
2019-10-03 15:47:49 -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 Make it possible to run ray examples as projects (#5816) 2019-10-03 14:52:37 -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 Improve manual Kubernetes deployment documentation (#5582) 2019-10-03 15:47:49 -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 And sphinx-gallery requirement to readthedocs. (#5780) 2019-09-25 14:46: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