Skip to content

Improve documentation on virtual dependencies #18346

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.

Sign up for GitHub

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

Merged
zanieb merged 2 commits into from
Mar 6, 2026
Merged

Improve documentation on virtual dependencies #18346

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57f7158
Improve documentation on virtual dependencies
luyiming Mar 6, 2026
a3c83d8
Fix code style issues
luyiming Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/concepts/projects/dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -859,9 +859,9 @@ uv allows dependencies to be "virtual", in which the dependency itself is not in
By default, dependencies are never virtual.

A dependency with a [`path` source](#path) can be virtual if it explicitly sets
[`tool.uv.package = false`](../../reference/settings.md#package). Unlike working _in_ the dependent
project with uv, the package will be built even if a [build system](./config.md#build-systems) is
not declared.
[`tool.uv.package = false`](../../reference/settings.md#package). Without this setting, uv treats
the path dependency as a normal package and will attempt to build it, even if the project does not
declare a [build system](./config.md#build-systems).

To treat a dependency as virtual, set `package = false` on the source:

Expand All @@ -885,8 +885,9 @@ bar = { path = "../projects/bar", package = true }
```

Similarly, a dependency with a [`workspace` source](#workspace-member) can be virtual if it
explicitly sets [`tool.uv.package = false`](../../reference/settings.md#package). The workspace
member will be built even if a [build system](./config.md#build-systems) is not declared.
explicitly sets [`tool.uv.package = false`](../../reference/settings.md#package). Without this
setting, the workspace member will be built even if a [build system](./config.md#build-systems) is
not declared.

Workspace members that are _not_ dependencies can be virtual by default, e.g., if the parent
`pyproject.toml` is:
Expand Down
Loading