f9b71a8bf6
This PR consolidates both #21667 and #21759 (look there for features), but improves on them in the following way: - [x] we reverted renaming of existing projects `tune`, `rllib`, `train`, `cluster`, `serve`, `raysgd` and `data` so that links won't break. I think my consolidation efforts with the `ray-` prefix were a little overeager in that regard. It's better like this. Only the creation of `ray-core` was a necessity, and some files moved into the `rllib` folder, so that should be relatively benign. - [x] Additionally, we added Algolia `docsearch`, screenshot below. This is _much_ better than our current search. Caveat: there's a sphinx dependency that needs to be replaced (`sphinx-tabs`) by another, newer one (`sphinx-panels`), as the former prevents loading of the `algolia.js` library. Will follow-up in the next PR (hoping this one doesn't get re-re-re-re-reverted).
1.8 KiB
Ray Documentation
Repository for documentation of the Ray project, hosted at docs.ray.io.
Installation
To build the documentation, make sure you have ray installed first.
For building the documentation locally install the following dependencies:
pip install -r requirements-doc.txt
Building the documentation
To compile the documentation and open it locally, run the following command from this directory.
make html && open _build/html/index.html
Building just one sub-project
Often your changes in documentation just concern one sub-project, such as Tune or Train. To build just this one sub-project, and ignore the rest (leading to build warnings due to broken references etc.), run the following command:
DOC_LIB=<project> sphinx-build -b html -d _build/doctrees source _build/html
where <project> is the name of the sub-project and can be any of the docs projects in the source/
directory either called tune, rllib, train, cluster, serve, raysgd, data or the ones starting
with ray-, e.g. ray-observability.
Announcements and includes
To add new announcements and other messaging to the top or bottom of a documentation page,
check the _includes folder first to see if the message you want is already there (like "get help"
or "we're hiring" etc.)
If not, add the template you want and include it accordingly, i.e. with
.. include:: /_includes/<my-announcement>
This ensures consistent messaging across documentation pages.
Checking for broken links
To check if there are broken links, run the following (we are currently not running this in the CI since there are false positives).
make linkcheck
Running doctests
To run tests for examples shipping with docstrings in Python files, run the following command:
make doctest