ray/doc
2021-10-12 18:32:29 -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] Port all MNIST examples to specify data_dir (#19033) 2021-10-12 15:36:06 +01:00
kubernetes [k8s][doc] Fix service name in K8s static deployment example (#19065) 2021-10-04 20:23:54 -05:00
site [docs] Move all /latest links to /master (#11897) 2020-11-10 10:53:28 -08:00
source [doc] Bump dataset to beta for 1.8 and add backlink to SGD (#19332) 2021-10-12 18:32:29 -07:00
tools Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
yarn [core] Deprecate QuotaAwareEvictionPolicy (#16911) 2021-07-07 13:44:41 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
BUILD [Core][Dataset] adding example for large scale data ingestion (#18998) 2021-10-11 15:37:09 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile [Core][Dataset] adding example for large scale data ingestion (#18998) 2021-10-11 15:37:09 -07:00
README.md [Docs] update docs readme and fix typo (#10807) 2020-09-15 12:51:18 -07:00
requirements-doc.txt [ci] Fix xgboost_ray install from git (#18640) 2021-09-15 18:07:15 +01: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