mirror of
https://github.com/vale981/ray
synced 2025-03-06 10:31:39 -05:00
4d08d3c188
Updating the docs to include pip installing `aiohttp` and `psutil`, both of which the dashboard requires. Since the whole dashboard section is optional, I thought I'd just add it in the docs rather than make it an explicit requirement of the project. Tell me if you'd prefer them as requirements in the `setup.py`, though. |
||
|---|---|---|
| .. | ||
| _build | ||
| dev | ||
| examples | ||
| kubernetes | ||
| site | ||
| source | ||
| tools | ||
| .gitignore | ||
| make.bat | ||
| Makefile | ||
| README.md | ||
| requirements-doc.txt | ||
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
make html
open _build/html/index.html
To test if there are any build errors with the documentation, do the following.
sphinx-build -W -b html -d _build/doctrees source _build/html