Skip to content

Commit 3e68dd0

Browse files
authored
Merge pull request #2271 from bids-standard/enh-makefile
chore: Add "serve" rule to Makefile and provide description to what actions available
2 parents 942636e + 61369a2 commit 3e68dd0

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,11 +268,12 @@ such as when you build the documentation locally.
268268
### 4. Ready to build!
269269

270270
Using the terminal (command line) please enter `uv run mkdocs serve`.
271+
Alternatively, if you would like to use `make`, run `make serve`, which will run `uv sync` and then `mkdocs`.
271272
This will allow you to see a local version of the specification.
272273
The local address will be `http://127.0.0.1:8000`.
273274
You may enter that into your browser and this will bring up the specification!
274275

275-
(If you are not using `uv`, activate your environment and then run `mkdocs serve`.)
276+
(If you are not using `uv` or `make`, activate your environment and then run `mkdocs serve`.)
276277

277278
## Fixing Markdown style errors
278279

Makefile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
.PHONY: tools/contributors.tsv
2+
3+
.PHONY: all serve install update_contributors formatschema
4+
25
all:
6+
@echo "Nothing is done by default. Consider following targets:"
7+
@echo " install -- prep environment"
8+
@echo " serve -- prep environment and build and serve docs"
9+
@echo " formatschema -- format and commit(!) schema"
10+
11+
serve: .venv
12+
uv run mkdocs serve
313

414
install: .venv node_modules
515

0 commit comments

Comments
 (0)