From 8a66efda271ec5854af1462efc56543024b70b8b Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Wed, 4 Sep 2024 12:33:53 -0500 Subject: [PATCH] Touchup to the project environment config section --- docs/concepts/projects.md | 4 ++-- docs/configuration/environment.md | 2 +- docs/guides/integration/docker.md | 2 +- docs/guides/integration/github.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/concepts/projects.md b/docs/concepts/projects.md index 27578b8ec181..71c58eb00f7b 100644 --- a/docs/concepts/projects.md +++ b/docs/concepts/projects.md @@ -293,7 +293,7 @@ use [`uvx`](../guides/tools.md) or managed = false ``` -### Custom project environment paths +### Configuring the project environment path The `UV_PROJECT_ENVIRONMENT` environment variable can be used to configure the project virtual environment path (`.venv` by default). @@ -310,7 +310,7 @@ the system in a broken state. If an absolute path is provided and the setting is used across multiple projects, the environment will be overwritten by invocations in each project. This setting is only recommended - for use in CI or Docker images. + for use for a single project in CI or Docker images. !!! note diff --git a/docs/configuration/environment.md b/docs/configuration/environment.md index 67e028212285..06d80a62f8f9 100644 --- a/docs/configuration/environment.md +++ b/docs/configuration/environment.md @@ -78,7 +78,7 @@ In addition, uv respects the following environment variables: - `UV_TOOL_BIN_DIR`: Used to specify the "bin" directory where uv will install tool executables. - `UV_PROJECT_ENVIRONMENT`: Use to specify the path to the directory to use for a project virtual environment. See the - [project documentation](../concepts/projects.md#custom-project-environment-paths) for more + [project documentation](../concepts/projects.md#configuring-the-project-environmen-path) for more details. - `UV_PYTHON_INSTALL_DIR`: Used to specify the directory where uv will store managed Python installations. diff --git a/docs/guides/integration/docker.md b/docs/guides/integration/docker.md index 7e88fb373815..fa3c10924765 100644 --- a/docs/guides/integration/docker.md +++ b/docs/guides/integration/docker.md @@ -155,7 +155,7 @@ RUN uv run some_script.py !!! tip Alternatively, the - [`UV_PROJECT_ENVIRONMENT` setting](../../concepts/projects.md#custom-project-environment-paths) can + [`UV_PROJECT_ENVIRONMENT` setting](../../concepts/projects.md#configuring-the-project-environmen-path) can be set before syncing to install to the system Python environment and skip environment activation entirely. diff --git a/docs/guides/integration/github.md b/docs/guides/integration/github.md index d7d400b4e7ea..496511824603 100644 --- a/docs/guides/integration/github.md +++ b/docs/guides/integration/github.md @@ -232,7 +232,7 @@ steps: !!! tip The - [`UV_PROJECT_ENVIRONMENT` setting](../../concepts/projects.md#custom-project-environment-paths) can + [`UV_PROJECT_ENVIRONMENT` setting](../../concepts/projects.md#configuring-the-project-environmen-path) can be used to install to the system Python environment instead of creating a virtual environment. ## Caching