README.md

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

Adding examples as MyST Markdown Notebooks

You can now add executable notebooks to this project, which will get built into the documentation. An example can be found here. By default, building the docs with make html will not run those notebooks. If you set the RUN_NOTEBOOKS environment variable to "cache", each notebook cell will be run when you build the documentation, and outputs will be cached into _build/.jupyter_cache.

RUN_NOTEBOOKS="cache" make html

To force re-running the notebooks, use RUN_NOTEBOOKS="force".

Using caching, this means the first time you build the documentation, it might take a while to run the notebooks. After that, notebook execution is only triggered when you change the notebook source file.

The benefits of working with notebooks for examples are that you don't separate the code from the documentation, but can still easily smoke-test the code.