mirror of https://github.com/wassname/ray.git synced 2026-07-05 09:24:28 +08:00

Files

T

Richard Liaw cc8f7db246 [docs] Improve cluster/docker docs (#3517 )

- Surfaces local cluster usage
 - Increases visability of these instructions
 - Removes some docker docs (that are really out of scope for Ray
 documentation IMO)

Closes #3517.

2018-12-12 10:40:54 -08:00

_build

Get Sphinx infrastructure in place

2016-07-01 18:21:02 -07:00

source

[docs] Improve cluster/docker docs (#3517 )

2018-12-12 10:40:54 -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