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
Robert Nishihara 1480f309c3 [doc] Replace runtest.py with mini_test.py in documentation. (#3750) 
Rename `xray_test.py` to `mini_test.py` and use that in the documentation. Right now we suggest that people run `runtest.py`, but that often doesn't succeed and takes too long.
2019-01-12 14:05:28 -08:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
source [doc] Replace runtest.py with mini_test.py in documentation. (#3750) 2019-01-12 14:05:28 -08: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 [sgd] Add file lock to protect compilation of sgd op (#3486) 2018-12-09 13:52:40 -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