Skip to content

Commit

Permalink
docs(configuration): clarify uv.toml precedence (#6986)
Browse files Browse the repository at this point in the history
## Summary

Add a note in the documentation to clarify that `uv.toml` files take
precedence over `[tool.uv]` section in `pyproject.toml`, based on the
warning shown in the CLI:

```console
$ uv version
warning: Found both a `uv.toml` file and a `[tool.uv]` section in an adjacent `pyproject.toml`. The `[tool.uv]` section will be ignored in favor of the `uv.toml` file.
uv 0.4.2 (Homebrew 2024-09-01)
```
  • Loading branch information
mkniewallner authored Sep 4, 2024
1 parent 1ccc15e commit 5cc7667
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/configuration/files.md
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

0 comments on commit 5cc7667

Please sign in to comment.