uv/docs/settings.md
Charlie Marsh 41cd4bee58
Add a generate-all step and auto-generate settings.md (#5080)
## Summary

Ensures that `generate-all` generates both the JSON Schema and the
`settings.md` API reference.
2024-07-15 19:58:53 +00:00

2.7 KiB

Global

index-url {: #index-url }

The URL of the Python package index (by default: https://pypi.org/simple).

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

The index provided by this setting is given lower priority than any indexes specified via extra_index_url.

Default value: https://pypi.org/simple

Type: str

Example usage:

=== "pyproject.toml"

```toml
[tool.uv]
index-url = "https://pypi.org/simple"
```

=== "uv.toml"

```toml

index-url = "https://pypi.org/simple"
```

managed {: #managed }

Whether the project is managed by uv. If false, uv will ignore the project when uv run is invoked.

Default value: true

Type: bool

Example usage:

=== "pyproject.toml"

```toml
[tool.uv]
managed = false
```

=== "uv.toml"

```toml

managed = false
```

pip

A [tool.uv.pip] section.

no-header {: #pip_no-header }

Exclude the comment header at the top of output file generated by uv pip compile.

Default value: false

Type: bool

Example usage:

=== "pyproject.toml"

```toml
[tool.uv.pip]
no-header = true
```

=== "uv.toml"

```toml
[pip]
no-header = true
```

workspace

exclude {: #workspace_exclude }

Packages to exclude as workspace members. If a package matches both members and exclude, it will be excluded.

Supports both globs and explicit paths.

For more information on the glob syntax, refer to the glob documentation.

Default value: []

Type: list[str]

Example usage:

=== "pyproject.toml"

```toml
[tool.uv.workspace]
exclude = ["member1", "path/to/member2", "libs/*"]
```

=== "uv.toml"

```toml
[workspace]
exclude = ["member1", "path/to/member2", "libs/*"]
```

members {: #workspace_members }

Packages to include as workspace members.

Supports both globs and explicit paths.

For more information on the glob syntax, refer to the glob documentation.

Default value: []

Type: list[str]

Example usage:

=== "pyproject.toml"

```toml
[tool.uv.workspace]
members = ["member1", "path/to/member2", "libs/*"]
```

=== "uv.toml"

```toml
[workspace]
members = ["member1", "path/to/member2", "libs/*"]
```