ray/doc
2021-06-20 19:38:34 -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 [Docs] Add e2e guide on using Pytorch Lightning with Ray (#16484) 2021-06-19 10:04:58 -07:00
kubernetes [doc][kubernetes] K8s doc updates (#16570) 2021-06-20 19:38:34 -07:00
site [docs] Move all /latest links to /master (#11897) 2020-11-10 10:53:28 -08:00
source [doc][kubernetes] K8s doc updates (#16570) 2021-06-20 19:38:34 -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 [Doc] [Core] [runtime env] Add runtime env doc (#16290) 2021-06-09 20:02:16 -05: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 Revert "[docs] readthedocs.yaml and remove requirements-rtd.txt (#16482)" (#16512) 2021-06-17 11:50:30 -07:00
requirements-rtd.txt Revert "[docs] readthedocs.yaml and remove requirements-rtd.txt (#16482)" (#16512) 2021-06-17 11:50:30 -07: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