Stefan Schneider 49ba51979e Functions for restoring from last or best checkpoint (#14735) | 3 years ago | |
---|---|---|
.. | ||
_build | 2e2bc2c740 Get Sphinx infrastructure in place | 8 years ago |
azure | c4ae94d60b [autoscaler] Azure deployment fixes (#11613) | 4 years ago |
examples | eb12033612 [Code Cleanup] Switch to use ray.util.get_node_ip_address() (#14741) | 3 years ago |
kubernetes | 58c0959ea7 [kubernetes][docs][minor] Move Kubernetes example scripts to docs (#14412) | 3 years ago |
site | 9b8218aabd [docs] Move all /latest links to /master (#11897) | 4 years ago |
source | 49ba51979e Functions for restoring from last or best checkpoint (#14735) | 3 years ago |
tools | 56d2cf6479 Shellcheck rewrites (#9597) | 4 years ago |
yarn | 4c3f09094a [docs] redis-port -> port (#10937) | 4 years ago |
.gitignore | 10f21fa313 [docs] Convert Examples to Gallery (#5414) | 5 years ago |
BUILD | 72615ae590 [metrics] Improve custom metrics docs, add an example on how to use them (#14690) | 3 years ago |
Makefile | 7e8ae50c53 Treat doc warnings as errors in Makefile to mirror CI linter (#14917) | 3 years ago |
README.md | 940f02913a [Docs] update docs readme and fix typo (#10807) | 4 years ago |
make.bat | 2e2bc2c740 Get Sphinx infrastructure in place | 8 years ago |
requirements-doc.txt | 91b9928ad5 [Serve] Add initial support for FastAPI ingress (#14754) | 3 years ago |
requirements-rtd.txt | 488f63efe3 [Dashboard] Make requests sent by the dashboard reverse proxy compatible (#14012) | 3 years ago |
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