ray/doc
2021-04-13 14:20:26 -07: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 [tune] Cache MNIST and restore MNIST tests (#15260) 2021-04-13 14:20:26 -07:00
kubernetes [kubernetes][docs][minor] Move Kubernetes example scripts to docs (#14412) 2021-03-01 20:17:16 -08:00
site [docs] Move all /latest links to /master (#11897) 2020-11-10 10:53:28 -08:00
source [tune] Cache MNIST and restore MNIST tests (#15260) 2021-04-13 14:20:26 -07: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] Cache MNIST and restore MNIST tests (#15260) 2021-04-13 14:20:26 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile Treat doc warnings as errors in Makefile to mirror CI linter (#14917) 2021-03-29 15:18:22 -07:00
README.md [Docs] update docs readme and fix typo (#10807) 2020-09-15 12:51:18 -07:00
requirements-doc.txt [Serve] Add initial support for FastAPI ingress (#14754) 2021-03-20 13:10:20 -05: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