You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contrib.md
+23-13Lines changed: 23 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,16 +21,7 @@ We use uv for managing dependencies. To install it, please follow the official g
21
21
After you have cloned the taskiq repo, install dependencies using this command:
22
22
23
23
```bash
24
-
uv sync
25
-
```
26
-
27
-
It will install all required dependencies.
28
-
If you want to run pytest against different python environments, please install `pyenv` using instructions from its [readme](https://github.com/pyenv/pyenv).
29
-
30
-
After pyenv is ready, you can install all python versions using this command:
31
-
32
-
```bash
33
-
pyenv install
24
+
uv sync --all-extras
34
25
```
35
26
36
27
## Linting
@@ -43,7 +34,6 @@ But even without installation, you can run all lints manually:
43
34
pre-commit run -a
44
35
```
45
36
46
-
47
37
## Testing
48
38
49
39
You can run `pytest` without any parameters and it will do the thing.
@@ -61,9 +51,29 @@ pytest -n 2
61
51
Also we use `tox` to test against different environments. You can publish a PR to run pytest with different
62
52
python versions, but if you want to do it locally, just run `tox` command.
63
53
64
-
65
54
```bash
66
55
tox
67
56
```
68
57
69
-
Tox assumes that you've installed python versions using pyenv with command above.
58
+
## Working with documentation
59
+
60
+
For documentation we use [VuePress 2](https://vuepress.vuejs.org/). To run documentation locally, use steps below.
61
+
62
+
First of all, install dependencies for documentation. We recommend to use `pnpm` for managing dependencies, but `package.json` is compatible with `npm` and `bun` for example as well:
63
+
64
+
```bash
65
+
pnpm i
66
+
```
67
+
68
+
After that, you can run documentation server with hot-reloading using:
69
+
70
+
```bash
71
+
pnpm docs:dev
72
+
```
73
+
74
+
If you want to check how documentation looks like in production mode, you can build it and then serve using:
0 commit comments