Skip to content

Better source-exclude reference docs #16832

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −2
Open

Better source-exclude reference docs #16832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions crates/uv-build-backend/src/settings.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ pub struct BuildBackendSettings {
pub default_excludes: bool,

/// Glob expressions which files and directories to exclude from the source distribution.
///
/// These excludes are also applied to wheel builds to avoid source tree to wheel builds
/// including more files than source tree to source distribution to wheel build.
Comment on lines +74 to +75
Copy link
Member

@zanieb zanieb Nov 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I find this wording a little confusing. Maybe...

These exclusions are also applied to wheels to ensure that a wheel built from the
source tree is consistent with a wheel built from the source distribution.

#[option(
default = r#"[]"#,
value_type = "list[str]",
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/build-backend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ From these,
[`tool.uv.build-backend.source-exclude`](../reference/settings.md#build-backend_source-exclude),
[`tool.uv.build-backend.wheel-exclude`](../reference/settings.md#build-backend_wheel-exclude) and
the default excludes are removed. The source dist excludes are applied to avoid source tree to wheel
source builds including more files than source tree to source distribution to wheel build.
builds including more files than source tree to source distribution to wheel build.

There are no specific wheel includes. There must only be one top level module, and all data files
must either be under the module root or in the appropriate
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -611,6 +611,9 @@ namespace = true

Glob expressions which files and directories to exclude from the source distribution.

These excludes are also applied to wheel builds to avoid source tree to wheel builds
including more files than source tree to source distribution to wheel build.

**Default value**: `[]`

**Type**: `list[str]`
Expand Down
2 changes: 1 addition & 1 deletion uv.schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading