Skip to content

docs(configuration): clarify uv.toml precedence #6986

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
charliermarsh merged 2 commits into from
Sep 4, 2024
Merged

docs(configuration): clarify uv.toml precedence #6986

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
333f8ec
docs(configuration): clarify `uv.toml` precedence
mkniewallner Sep 3, 2024
5292b9b
Tweaks
charliermarsh Sep 4, 2024
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
6 changes: 6 additions & 0 deletions docs/configuration/files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ uv will also search for `uv.toml` files, which follow an identical structure, bu
index-url = "https://test.pypi.org/simple"
```

!!! note

`uv.toml` files take precedence over `pyproject.toml` files, so if both `uv.toml` and
`pyproject.toml` files are present in a directory, configuration will be read from `uv.toml`, and
`[tool.uv]` section in the accompanying `pyproject.toml` will be ignored.

uv will also discover user-level configuration at `~/.config/uv/uv.toml` (or
`$XDG_CONFIG_HOME/uv/uv.toml`) on macOS and Linux, or `%APPDATA%\uv\uv.toml` on Windows. User-level
configuration must use the `uv.toml` format, rather than the `pyproject.toml` format, as a
Expand Down