ray/doc
Richard Liaw d482aa5aed Making our landing pages look better (#1022)
* Teaser in the front page of docs

* TEASER

* try changing README

* spacing

* readme

* power words

* readme obj_id change

* obj_ids change for docs

* Updates to readme.

* Update landing page in documentation.

* Fix linting.
2017-09-30 15:37:28 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
source Making our landing pages look better (#1022) 2017-09-30 15:37:28 -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 [rllib] Changes for preprocessors (#1033) 2017-09-30 13:11:20 -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