File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -3,24 +3,45 @@ Development
33
44First install the external dependencies, see :doc: `./getting_started `.
55
6+ Both ``poetry `` and ``uv `` are supported for development.
7+
8+ poetry
9+ ^^^^^^
10+
611To run the tests:
712
813.. code-block :: console
914
1015 $ poetry install
11- $ poetry self add poetry-plugin-shell # once
12- $ poetry shell
13- $ pip install -e .
16+ $ poetry run pip install -e .
1417 # change things
15- $ pytest
18+ $ poetry run pytest
1619
1720 To work on the documentation:
1821
1922.. code-block :: console
2023
2124 $ poetry install --with docs
22- $ poetry self add poetry-plugin-shell # once
23- $ poetry shell
24- $ cd docs
25- $ make watch
25+ $ poetry run make -C docs watch
26+ # See http://127.0.0.1:8000
27+
28+ uv
29+ ^^
30+
31+ To run the tests:
32+
33+ .. code-block :: console
34+
35+ $ uv sync
36+ $ uv pip install -e .
37+ # change things
38+ $ uv run pytest
39+
40+ To work on the documentation:
41+
42+ .. code-block :: console
43+
44+ $ uv sync --group docs
45+ $ uv run make -C docs watch
2646 # See http://127.0.0.1:8000
47+
You can’t perform that action at this time.
0 commit comments