Skip to content

Commit

Permalink
[docs] clarify FAST build option, fixes ray-project#35293 (ray-projec…
Browse files Browse the repository at this point in the history
…t#35297)

nit changes (sub-project --> subproject)

Signed-off-by: Max Pumperla <[email protected]>
Signed-off-by: e428265 <[email protected]>
  • Loading branch information
maxpumperla authored and arvind-chandra committed Aug 31, 2023
1 parent 7f33c5d commit 6f8c6c7
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,20 @@ make develop && open _build/html/index.html

> **_NOTE:_** The above command is for development. To reproduce build failures from the
> CI, you should use `make html` which is the same as `make develop` but treats warnings as errors.
> Additionally, note that `make develop` uses the `FAST` environment variable to skip some
> expensive parts of the build process. In particular, it will aggressively prune the
> left-hand side navigation, but leave the documents itself intact.
## Building just one sub-project
## Building just one subproject

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
Often your changes in documentation just concern one subproject, such as Tune or Train.
To build just this one subproject, and ignore the rest
(leading to build warnings due to broken references etc.), run the following command:

```shell
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/`
where `<project>` is the name of the subproject and can be any of the docs projects in the `source/`
directory either called `tune`, `rllib`, `train`, `cluster`, `serve`, `data` or the ones starting
with `ray-`, e.g. `ray-observability`.

Expand Down

0 comments on commit 6f8c6c7

Please sign in to comment.