From b00904a6df2a38c9776b0b2ca80b9be977f30381 Mon Sep 17 00:00:00 2001 From: Artem Hermes Bot Date: Wed, 13 May 2026 22:08:12 +0000 Subject: [PATCH 1/2] doc: add UV setup details to README.md --- doc/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/doc/README.md b/doc/README.md index 296b6dee0ee..a370d3d1dbf 100644 --- a/doc/README.md +++ b/doc/README.md @@ -179,3 +179,33 @@ So, you cannot have `#123 `__ See `conf.py` for list of currently defined link shorteners. + +### UV setup details + +The documentation build process uses [UV](https://github.com/astral-sh/uv) to manage Python dependencies. +UV is a fast Python package installer and resolver, written in Rust. + +The following UV commands are used in the Makefile and documentation: + +- `uv sync`: Installs the dependencies listed in `uv.lock` (or resolves them from `pyproject.toml` if the lock file is missing). +- `uv export --frozen --format requirements.txt`: Exports the resolved dependencies to a `requirements.txt` file (used for skjold checks). +- `uv pip list --outdated`: Lists outdated dependencies (for updating). +- `uv sync --upgrade`: Upgrades the dependencies to the latest versions allowed by `pyproject.toml` and updates the lock file. +- `uvx skjold`: Runs the skjold tool (for security vulnerability checks) in an isolated environment. + +To get started with UV, you can install it via the official installer: + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +Or via Homebrew (on macOS): + +```bash +brew install uv +``` + +After installing UV, you can run the documentation build as usual. + +Note: The `uv.lock` file in the `doc/` directory is committed to the repository to ensure reproducible builds. +When updating dependencies, remember to commit the updated `uv.lock` and `pyproject.toml` (if bounds are changed). From b01fa80e900a77ab8264f152e4d588ea141df42c Mon Sep 17 00:00:00 2001 From: Artem Pelenitsyn Date: Fri, 22 May 2026 09:37:34 -0400 Subject: [PATCH 2/2] Revise UV setup details in README --- doc/README.md | 17 +++-------------- 1 file changed, 3 insertions(+), 14 deletions(-) diff --git a/doc/README.md b/doc/README.md index a370d3d1dbf..94292b674ac 100644 --- a/doc/README.md +++ b/doc/README.md @@ -24,7 +24,8 @@ and instead set `LC_ALL=en_US.UTF-8`. ### How to update dependencies The list of transitive dependencies (`requirements.txt`) is generated from the -list of direct dependencies in `pyproject.toml`. Find outdated dependencies with: +list of direct dependencies in `pyproject.toml`. Find outdated dependencies using UV +(see also "UV setup details" section at the bottom) with: ```console > cd doc @@ -184,6 +185,7 @@ So, you cannot have The documentation build process uses [UV](https://github.com/astral-sh/uv) to manage Python dependencies. UV is a fast Python package installer and resolver, written in Rust. +To get started with UV, you can install it following the [official instructions]([url](https://docs.astral.sh/uv/getting-started/installation/#installation-methods)). The following UV commands are used in the Makefile and documentation: @@ -193,19 +195,6 @@ The following UV commands are used in the Makefile and documentation: - `uv sync --upgrade`: Upgrades the dependencies to the latest versions allowed by `pyproject.toml` and updates the lock file. - `uvx skjold`: Runs the skjold tool (for security vulnerability checks) in an isolated environment. -To get started with UV, you can install it via the official installer: - -```bash -curl -LsSf https://astral.sh/uv/install.sh | sh -``` - -Or via Homebrew (on macOS): - -```bash -brew install uv -``` - -After installing UV, you can run the documentation build as usual. Note: The `uv.lock` file in the `doc/` directory is committed to the repository to ensure reproducible builds. When updating dependencies, remember to commit the updated `uv.lock` and `pyproject.toml` (if bounds are changed).