infra: api docs quick preview (#22093)

This commit is contained in:
Bagatur
2024-05-23 13:57:45 -07:00
committed by GitHub
parent fe26f937e4
commit 38783d07c9
2 changed files with 21 additions and 1 deletions

View File

@@ -71,6 +71,8 @@ make docs_clean
make api_docs_clean
```
Next, you can build the documentation as outlined below:
```bash
@@ -78,6 +80,18 @@ make docs_build
make api_docs_build
```
:::tip
The `make api_docs_build` command takes a long time. If you're making cosmetic changes to the API docs and want to see how they look, use:
```bash
make api_docs_quick_preview
```
which will just build a small subset of the API reference.
:::
Finally, run the link checker to ensure all links are valid:
```bash