Skip to content

Commit

Permalink
Touchup to the project environment config section (#7038)
Browse files Browse the repository at this point in the history
  • Loading branch information
zanieb authored Sep 4, 2024
1 parent bbaf664 commit 5ca3ded
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/concepts/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-environment-path) for more
details.
- `UV_PYTHON_INSTALL_DIR`: Used to specify the directory where uv will store managed Python
installations.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-environment-path) can
be set before syncing to install to the system Python environment and skip environment activation
entirely.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-environment-path) can
be used to install to the system Python environment instead of creating a virtual environment.

## Caching
Expand Down

0 comments on commit 5ca3ded

Please sign in to comment.