Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add missing uv command for docs generation in contributing guide #1197

Merged
merged 1 commit into from
Feb 21, 2025

Conversation

terrytangyuan
Copy link
Collaborator

@terrytangyuan terrytangyuan commented Feb 21, 2025

What does this PR do?

$ ./docs/openapi_generator/run_openapi_generator.sh
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "/home/yutang/repos/llama-stack/docs/openapi_generator/generate.py", line 16, in <module>
    import fire
ModuleNotFoundError: No module named 'fire'

Test Plan

Tested the command uv run ./docs/openapi_generator/run_openapi_generator.sh successfully.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Feb 21, 2025
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had no clue you could run arbitrary scripts via uv run

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv is a gem!

@ashwinb ashwinb merged commit 35de423 into main Feb 21, 2025
3 checks passed
@ashwinb ashwinb deleted the terrytangyuan-patch-2 branch February 21, 2025 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants