Skip to content

Commit 711fdf8

Browse files
committed
docs(contributing/workflow): Update make commands to just
why: Project now uses justfile instead of Makefile what: - Replace make commands with just equivalents - Update tab references from make to just - Remove duplicate mypy section
1 parent 2647c07 commit 711fdf8

File tree

1 file changed

+15
-53
lines changed

1 file changed

+15
-53
lines changed

docs/contributing/workflow.md

Lines changed: 15 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -18,36 +18,35 @@ $ cd libvcs
1818
$ uv install -E "docs test coverage lint"
1919
```
2020

21-
Makefile commands prefixed with `watch_` will watch files and rerun.
21+
Justfile commands prefixed with `watch-` will watch files and rerun.
2222

2323
## Tests
2424

2525
```console
2626
$ uv run py.test
2727
```
2828

29-
Helpers: `make test` Rerun tests on file change: `make watch_test` (requires [entr(1)])
29+
Helpers: `just test` Rerun tests on file change: `just watch-test` (requires [entr(1)])
3030

3131
## Documentation
3232

3333
Default preview server: http://localhost:8068
3434

3535
[sphinx-autobuild] will automatically build the docs, watch for file changes and launch a server.
3636

37-
From home directory: `make start_docs` From inside `docs/`: `make start`
37+
From home directory: `just start-docs` From inside `docs/`: `just start`
3838

3939
[sphinx-autobuild]: https://github.com/executablebooks/sphinx-autobuild
4040

4141
### Manual documentation (the hard way)
4242

43-
`cd docs/` and `make html` to build. `make serve` to start http server.
43+
`cd docs/` and `just html` to build. `just serve` to start http server.
4444

45-
Helpers: `make build_docs`, `make serve_docs`
45+
Helpers: `just build-docs`, `just serve-docs`
4646

47-
Rebuild docs on file change: `make watch_docs` (requires [entr(1)])
47+
Rebuild docs on file change: `just watch-docs` (requires [entr(1)])
4848

49-
Rebuild docs and run server via one terminal: `make dev_docs` (requires above, and a `make(1)` with
50-
`-J` support, e.g. GNU Make)
49+
Rebuild docs and run server via one terminal: `just dev-docs`
5150

5251
## Formatting / linting
5352

@@ -71,18 +70,18 @@ $ ruff check .
7170
7271
````
7372

74-
````{tab} make
73+
````{tab} just
7574
7675
```console
77-
$ make ruff
76+
$ just ruff
7877
```
7978
8079
````
8180

8281
````{tab} Watch
8382
8483
```console
85-
$ make watch_ruff
84+
$ just watch-ruff
8685
```
8786
8887
requires [`entr(1)`].
@@ -125,10 +124,10 @@ $ ruff format .
125124
126125
````
127126

128-
````{tab} make
127+
````{tab} just
129128
130129
```console
131-
$ make ruff_format
130+
$ just ruff-format
132131
```
133132
134133
````
@@ -153,55 +152,18 @@ $ mypy .
153152
154153
````
155154

156-
````{tab} make
155+
````{tab} just
157156
158157
```console
159-
$ make mypy
158+
$ just mypy
160159
```
161160
162161
````
163162

164163
````{tab} Watch
165164
166165
```console
167-
$ make watch_mypy
168-
```
169-
170-
requires [`entr(1)`].
171-
````
172-
173-
### mypy
174-
175-
[mypy] is used for static type checking.
176-
177-
````{tab} Command
178-
179-
uv:
180-
181-
```console
182-
$ uv run mypy .
183-
```
184-
185-
If you setup manually:
186-
187-
```console
188-
$ mypy .
189-
```
190-
191-
````
192-
193-
````{tab} make
194-
195-
```console
196-
$ make mypy
197-
```
198-
199-
````
200-
201-
````{tab} Watch
202-
203-
```console
204-
$ make watch_mypy
166+
$ just watch-mypy
205167
```
206168
207169
requires [`entr(1)`].

0 commit comments

Comments
 (0)