ray/doc
2021-02-24 18:31:59 -08:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
azure [autoscaler] Azure deployment fixes (#11613) 2020-10-27 15:27:18 -07:00
examples [docs] new Ray Cluster documentation (#13839) 2021-02-15 00:47:14 -08:00
kubernetes [autoscaler][kubernetes][docs] Updated Kubernetes Documentation (#14016) 2021-02-11 23:00:25 -08:00
site [docs] Move all /latest links to /master (#11897) 2020-11-10 10:53:28 -08:00
source [Dashboard] Make requests sent by the dashboard reverse proxy compatible (#14012) 2021-02-24 18:31:59 -08:00
tools Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
yarn [docs] redis-port -> port (#10937) 2020-09-23 17:04:13 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
BUILD [tune] Try to enable PTL, SKlearn tests (#11542) 2020-10-24 01:08:46 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile [tune] New Doc edits, add Concepts page (#8083) 2020-04-25 18:25:56 -07:00
README.md [Docs] update docs readme and fix typo (#10807) 2020-09-15 12:51:18 -07:00
requirements-doc.txt [docs] new Ray Cluster documentation (#13839) 2021-02-15 00:47:14 -08:00
requirements-rtd.txt [Dashboard] Make requests sent by the dashboard reverse proxy compatible (#14012) 2021-02-24 18:31:59 -08: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
pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
make html
open _build/html/index.html

To test if there are any build errors with the documentation, do the following.

sphinx-build -b html -d _build/doctrees source _build/html