Skip to content

Commit 5507734

Browse files
committed
update dev docs: uv and just instead of tox
1 parent 3a5692d commit 5507734

File tree

1 file changed

+7
-17
lines changed

1 file changed

+7
-17
lines changed

docs/devs/index.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -51,29 +51,19 @@ incorporated in the main repository and made available to other users.
5151
Testing
5252
-------
5353

54-
StagPy uses [tox for code testing](https://tox.wiki/). Make sure it
55-
is installed and up to date on your system:
54+
StagPy uses [uv to manage dev environments](https://docs.astral.sh/uv/).
55+
It also uses [just to run commands](https://just.systems/man/en/).
5656

57-
```sh title="shell"
58-
python3 -m pip install -U tox
59-
```
60-
61-
Launching `tox` at the root of the repository will automatically run the tests
62-
in a virtual environment. Before submitting modifications to the code, please
63-
make sure they pass the tests by running `tox`.
57+
Launching `just` from anywhere in the repository will automatically run checks
58+
and tests in a virtual environment. Before submitting modifications to the
59+
code, please make sure they pass the tests by running `just`.
6460

6561
Documentation
6662
-------------
6763

6864
The StagPy documentation is built with [MkDocs](https://www.mkdocs.org/). To
69-
build it locally, install the needed packages:
70-
71-
```sh title="shell"
72-
python3 -m pip install -r docs/requirements.txt
73-
```
74-
75-
Then, run:
65+
build it locally, run:
7666

7767
```sh title="shell"
78-
mkdocs serve
68+
just mkdocs serve
7969
```

0 commit comments

Comments
 (0)