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
Timon Ruban 2702b15b04 [tune] Add requirements-dev.txt and update docs for contributing (#4925) 
* Add requirements-dev.txt and update docs.

* Update doc/source/tune-contrib.rst

Co-Authored-By: Richard Liaw <rliaw@berkeley.edu>

* Unpin everything except for yapf.
2019-06-05 09:04:36 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
source [tune] Add requirements-dev.txt and update docs for contributing (#4925) 2019-06-05 09:04:36 -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 Make Bazel the default build system (#3898) 2019-02-23 11:58:59 -08: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