ray/doc/README.md
Robert Nishihara 6a4bde54dc Only install ray python packages. (#330)
* Only install ray python packages.

* Add some __init__.py files.

* Install Ray before building documentation.

* Fix install-ray.sh.

* Fix.
2017-03-01 23:34:44 -08:00

16 lines
373 B
Markdown

# 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
```