mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-07-07 21:35:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

generate docs properly

Browse source
This commit is contained in:
Jack O'Connor 2025-05-28 20:08:05 -07:00
parent 5062b615ee
commit 20d2cd93b7
3 changed files with 11 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

3
crates/uv-static/src/env_vars.rs
View file

@ -256,6 +256,9 @@ impl EnvVars {
/// for more details.
pub const UV_PROJECT_ENVIRONMENT: &'static str = "UV_PROJECT_ENVIRONMENT";
/// Equivalent to the `--active` command line argument. If set, uv will look at `VIRTUAL_ENV`
/// and use the active virtual environment, if any. If `VIRTUAL_ENV` is not defined, this has
/// no effect.
pub const UV_USE_ACTIVE_ENVIRONMENT: &'static str = "UV_USE_ACTIVE_ENVIRONMENT";
/// Specifies the directory to place links to installed, managed Python executables.

5
docs/configuration/environment.md
View file

@ -431,8 +431,9 @@ the installer from modifying shell profiles or environment variables.
### `UV_USE_ACTIVE_ENVIRONMENT`
Equivalent to the `--active` command line argument. If set, uv will look at `VIRTUAL_ENV` and use
the active virtual environment, if any. If `VIRTUAL_ENV` is not defined, this has no effect.
Equivalent to the `--active` command line argument. If set, uv will look at `VIRTUAL_ENV`
and use the active virtual environment, if any. If `VIRTUAL_ENV` is not defined, this has
no effect.
### `UV_VENV_SEED`

15
docs/reference/cli.md
View file

@ -56,8 +56,7 @@ uv run [OPTIONS] [COMMAND]
<dl class="cli-reference"><dt id="uv-run--active"><a href="#uv-run--active"><code>--active</code></a></dt><dd><p>Prefer the active virtual environment over the project's virtual environment.</p>
<p>If the project virtual environment is active or no virtual environment is active, this has no effect.</p>
<p>May also be set with the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p>
</dd><dt id="uv-run--all-extras"><a href="#uv-run--all-extras"><code>--all-extras</code></a></dt><dd><p>Include all optional dependencies.</p>
<p>May also be set with the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p></dd><dt id="uv-run--all-extras"><a href="#uv-run--all-extras"><code>--all-extras</code></a></dt><dd><p>Include all optional dependencies.</p>
<p>Optional dependencies are defined via <code>project.optional-dependencies</code> in a <code>pyproject.toml</code>.</p>
<p>This option is only available when running in a project.</p>
</dd><dt id="uv-run--all-groups"><a href="#uv-run--all-groups"><code>--all-groups</code></a></dt><dd><p>Include dependencies from all dependency groups.</p>
@ -411,8 +410,7 @@ uv add [OPTIONS] <PACKAGES|--requirements <REQUIREMENTS>>
<dl class="cli-reference"><dt id="uv-add--active"><a href="#uv-add--active"><code>--active</code></a></dt><dd><p>Prefer the active virtual environment over the project's virtual environment.</p>
<p>If the project virtual environment is active or no virtual environment is active, this has no effect.</p>
<p>May also be set with the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p>
</dd><dt id="uv-add--allow-insecure-host"><a href="#uv-add--allow-insecure-host"><code>--allow-insecure-host</code></a>, <code>--trusted-host</code> <i>allow-insecure-host</i></dt><dd><p>Allow insecure connections to a host.</p>
<p>May also be set with the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p></dd><dt id="uv-add--allow-insecure-host"><a href="#uv-add--allow-insecure-host"><code>--allow-insecure-host</code></a>, <code>--trusted-host</code> <i>allow-insecure-host</i></dt><dd><p>Allow insecure connections to a host.</p>
<p>Can be provided multiple times.</p>
<p>Expects to receive either a hostname (e.g., <code>localhost</code>), a host-port pair (e.g., <code>localhost:8080</code>), or a URL (e.g., <code>https://localhost</code>).</p>
<p>WARNING: Hosts included in this list will not be verified against the system's certificate store. Only use <code>--allow-insecure-host</code> in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.</p>
@ -615,8 +613,7 @@ uv remove [OPTIONS] <PACKAGES>...
<dl class="cli-reference"><dt id="uv-remove--active"><a href="#uv-remove--active"><code>--active</code></a></dt><dd><p>Prefer the active virtual environment over the project's virtual environment.</p>
<p>If the project virtual environment is active or no virtual environment is active, this has no effect.</p>
<p>May also be set with the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p>
</dd><dt id="uv-remove--allow-insecure-host"><a href="#uv-remove--allow-insecure-host"><code>--allow-insecure-host</code></a>, <code>--trusted-host</code> <i>allow-insecure-host</i></dt><dd><p>Allow insecure connections to a host.</p>
<p>May also be set with the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p></dd><dt id="uv-remove--allow-insecure-host"><a href="#uv-remove--allow-insecure-host"><code>--allow-insecure-host</code></a>, <code>--trusted-host</code> <i>allow-insecure-host</i></dt><dd><p>Allow insecure connections to a host.</p>
<p>Can be provided multiple times.</p>
<p>Expects to receive either a hostname (e.g., <code>localhost</code>), a host-port pair (e.g., <code>localhost:8080</code>), or a URL (e.g., <code>https://localhost</code>).</p>
<p>WARNING: Hosts included in this list will not be verified against the system's certificate store. Only use <code>--allow-insecure-host</code> in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.</p>
@ -780,8 +777,7 @@ uv version [OPTIONS] [VALUE]
<dl class="cli-reference"><dt id="uv-version--active"><a href="#uv-version--active"><code>--active</code></a></dt><dd><p>Prefer the active virtual environment over the project's virtual environment.</p>
<p>If the project virtual environment is active or no virtual environment is active, this has no effect.</p>
<p>May also be set with the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p>
</dd><dt id="uv-version--allow-insecure-host"><a href="#uv-version--allow-insecure-host"><code>--allow-insecure-host</code></a>, <code>--trusted-host</code> <i>allow-insecure-host</i></dt><dd><p>Allow insecure connections to a host.</p>
<p>May also be set with the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p></dd><dt id="uv-version--allow-insecure-host"><a href="#uv-version--allow-insecure-host"><code>--allow-insecure-host</code></a>, <code>--trusted-host</code> <i>allow-insecure-host</i></dt><dd><p>Allow insecure connections to a host.</p>
<p>Can be provided multiple times.</p>
<p>Expects to receive either a hostname (e.g., <code>localhost</code>), a host-port pair (e.g., <code>localhost:8080</code>), or a URL (e.g., <code>https://localhost</code>).</p>
<p>WARNING: Hosts included in this list will not be verified against the system's certificate store. Only use <code>--allow-insecure-host</code> in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.</p>
@ -960,8 +956,7 @@ uv sync [OPTIONS]
<dl class="cli-reference"><dt id="uv-sync--active"><a href="#uv-sync--active"><code>--active</code></a></dt><dd><p>Sync dependencies to the active virtual environment.</p>
<p>Instead of creating or updating the virtual environment for the project or script, the active virtual environment will be preferred, if the <code>VIRTUAL_ENV</code> environment variable is set.</p>
<p>Alternatively you can use the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p>
</dd><dt id="uv-sync--all-extras"><a href="#uv-sync--all-extras"><code>--all-extras</code></a></dt><dd><p>Include all optional dependencies.</p>
<p>May also be set with the <code>UV_USE_ACTIVE_ENVIRONMENT</code> environment variable.</p></dd><dt id="uv-sync--all-extras"><a href="#uv-sync--all-extras"><code>--all-extras</code></a></dt><dd><p>Include all optional dependencies.</p>
<p>When two or more extras are declared as conflicting in <code>tool.uv.conflicts</code>, using this flag will always result in an error.</p>
<p>Note that all optional dependencies are always included in the resolution; this option only affects the selection of packages to install.</p>
</dd><dt id="uv-sync--all-groups"><a href="#uv-sync--all-groups"><code>--all-groups</code></a></dt><dd><p>Include dependencies from all dependency groups.</p>