From 6352078e4be032f1ed0d1a53f17b10863905e9bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Han?= Date: Wed, 28 May 2025 18:13:16 +0200 Subject: [PATCH] chore: use groups when running commands (#2298) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # What does this PR do? Followup of https://github.com/meta-llama/llama-stack/pull/2287. We must use `--group` when running commands with uv. Signed-off-by: Sébastien Han --- CONTRIBUTING.md | 6 +++--- docs/readme.md | 2 +- pyproject.toml | 2 +- tests/verifications/README.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f71a6ba1..10e3f6cee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -168,10 +168,10 @@ If you are making changes to the documentation at [https://llama-stack.readthedo ```bash # This rebuilds the documentation pages. -uv run --with ".[docs]" make -C docs/ html +uv run --group docs make -C docs/ html # This will start a local server (usually at http://127.0.0.1:8000) that automatically rebuilds and refreshes when you make changes to the documentation. -uv run --with ".[docs]" sphinx-autobuild docs/source docs/build/html --write-all +uv run --group docs sphinx-autobuild docs/source docs/build/html --write-all ``` ### Update API Documentation @@ -179,7 +179,7 @@ uv run --with ".[docs]" sphinx-autobuild docs/source docs/build/html --write-all If you modify or add new API endpoints, update the API documentation accordingly. You can do this by running the following command: ```bash -uv run --with ".[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. diff --git a/docs/readme.md b/docs/readme.md index d84dbe6eb..c238c4720 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -6,7 +6,7 @@ Here's a collection of comprehensive guides, examples, and resources for buildin From the llama-stack root directory, run the following command to render the docs locally: ```bash -uv run --with ".[docs]" sphinx-autobuild docs/source docs/build/html --write-all +uv run --group docs sphinx-autobuild docs/source docs/build/html --write-all ``` You can open up the docs in your browser at http://localhost:8000 diff --git a/pyproject.toml b/pyproject.toml index 21c453809..043149b40 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -84,7 +84,7 @@ unit = [ ] # These are the core dependencies required for running integration tests. They are shared across all # providers. If a provider requires additional dependencies, please add them to your environment -# separately. If you are using "uv" to execute your tests, you can use the "--with" flag to specify extra +# separately. If you are using "uv" to execute your tests, you can use the "--group" flag to specify extra # dependencies. test = [ "openai", diff --git a/tests/verifications/README.md b/tests/verifications/README.md index 19d122bec..b6c332cac 100644 --- a/tests/verifications/README.md +++ b/tests/verifications/README.md @@ -27,7 +27,7 @@ export TOGETHER_API_KEY= ``` then run ```bash -uv run --with-editable ".[dev]" python tests/verifications/generate_report.py --run-tests +uv run python tests/verifications/generate_report.py --run-tests ``` ## Running Tests