ray/doc
Simon Mo fcb6bdbc39
[Doc] Document Actor.options API (#6099)
* Document Actor.options API

* Undocument _remote
2019-11-06 23:12:23 -08:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
dev Update release doc (#5988) 2019-10-24 11:13:37 -07:00
examples [docs] fix code block display (#5967) 2019-10-22 00:45:38 -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 [Doc] Document Actor.options API (#6099) 2019-11-06 23:12:23 -08: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 [Serve] Use ray's cloudpickle (#6051) 2019-10-30 15:21:09 -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