hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-06 02:21:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ray/doc
History
Eric Liang a101812b9f
Replace --redis-address with --address in test, docs, tune, rllib (#5602) 
* wip

* add tests and tune

* add ci

* test fix

* lint

* fix tests

* wip

* sugar dep
2019-09-01 16:53:02 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
dev Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
examples [docs] Second push of changes (#5391) 2019-08-28 17:54:15 -07:00
kubernetes Fixed few broken links in docs (#5477) 2019-08-19 14:22:25 -07:00
site Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
source Replace --redis-address with --address in test, docs, tune, rllib (#5602) 2019-09-01 16:53:02 -07:00
tools Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -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 [projects] Project examples and documentation (#5407) 2019-08-20 20:49:15 -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