Skip to content

Commit 5807a39

Browse files
RTD: add a developer comment in .readthedocs.yml (#6864)
When `uv` creates a virtual environment, it will not automatically activate it. However this is not a problem, since the subsequent commands in `.readthedocs.yml`, meaning `uv sync` & `uv run` both pick up the created environment automatically. This commit clarifies the behavior for developers. --------- Co-authored-by: Daniel Hollas <[email protected]>
1 parent e257b3c commit 5807a39

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

.readthedocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ build:
2020
- asdf install uv 0.5.22
2121
- asdf global uv 0.5.22
2222
create_environment:
23+
# Create a virtual environment in '.venv/' folder
24+
# which is picked up automatically by `uv sync` and `uv run` commands below
2325
- uv venv
2426
install:
2527
- uv sync --extra docs --extra tests --extra rest --extra atomic_tools

0 commit comments

Comments
 (0)