mirror of
https://github.com/astral-sh/uv.git
synced 2025-08-03 18:38:21 +00:00
211fa91c2a
<!-- Thank you for contributing to uv! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? - Does this pull request include references to any relevant issues? --> ## Summary Part of https://github.com/astral-sh/uv/issues/7007. Settings documentation reference currently doesn't separate "project metadata" and "configuration" options, implying that it's possible to set things like `dev-dependencies` in `uv.toml` while it's not. This is an attempt at better separating those options, by having 2 different sections: - `Project metadata`, that holds configuration that can only be set in `pyproject.toml` - `Configuration`, that holds configuration that can be set both in `pyproject.toml` and `uv.toml` Here are some screenshots to show what this looks like (note that I don't have code highlighting in the right navigation, which makes them clunky, as first item is always bigger because of the missing "span" -- I think that's because it's an `mkdocs-material` insider feature, since I have the same thing on `main` branch): - Right side navigation: <img width="241" alt="Screenshot 2024-09-05 at 01 19 50" src="https://github.com/user-attachments/assets/012f64a4-8d34-4e34-a506-8d02dc1fbf98"> <img width="223" alt="Screenshot 2024-09-05 at 01 20 01" src="https://github.com/user-attachments/assets/0b0fb71d-c9c3-4ee3-8f6e-cf35180b1a99"> - An option from "Project metadata" section that only applies to `pyproject.toml`: <img width="788" alt="Screenshot 2024-09-05 at 01 20 11" src="https://github.com/user-attachments/assets/64349fbb-8623-4b81-a475-d6ff38c658f1"> - An option from "Configuration" section that applies both to `pyproject.toml` and `uv.toml`: <img width="787" alt="Screenshot 2024-09-05 at 01 20 33" src="https://github.com/user-attachments/assets/732e43d3-cc64-4f5a-8929-23a5555d4c53"> ## Test Plan Local run of the documentation. Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com> |
||
|---|---|---|
| .. | ||
| benchmarks.md | ||
| cli.md | ||
| index.md | ||
| platforms.md | ||
| resolver-internals.md | ||
| settings.md | ||
| versioning.md | ||