Skip to content

Commit

Permalink
docs: Add missing uv command for docs generation in contributing guide (
Browse files Browse the repository at this point in the history
#1197)

# What does this PR do?

```
make html
/bin/sh: line 1: sphinx-build: command not found
make: *** [Makefile:20: html] Error 127
```

## Test Plan

Tested the command `uv run
./docs/openapi_generator/run_openapi_generator.sh` successfully.
  • Loading branch information
terrytangyuan authored Feb 21, 2025
1 parent 35ae0e1 commit 35de423
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ If you modify or add new API endpoints, update the API documentation accordingly

```bash
$ uv sync --extra dev
$ ./docs/openapi_generator/run_openapi_generator.sh
$ uv run ./docs/openapi_generator/run_openapi_generator.sh
```

The generated API documentation will be available in `docs/_static/`. Make sure to review the changes before committing.
Expand Down

0 comments on commit 35de423

Please sign in to comment.