From 1dadf147503eff09a3523bbbc4e141992c205575 Mon Sep 17 00:00:00 2001 From: Julian Dehm Date: Tue, 12 Nov 2024 17:37:46 +0100 Subject: [PATCH] Makefile: add docs command to see documentation --- Makefile | 5 +++++ changelog/_0002.md | 4 ++++ 2 files changed, 9 insertions(+) create mode 100644 changelog/_0002.md diff --git a/Makefile b/Makefile index cef7336fe..63bdb63bb 100644 --- a/Makefile +++ b/Makefile @@ -52,6 +52,7 @@ help: @echo " make celery-worker-start -- starts the celery worker in the foreground" @echo " make celery-worker-status -- lists all registered tasks and active worker nodes" @echo " make celery-worker-dummy-task -- calls the dummy task and prints result from redis" + @echo " make docs -- run the mkdocs server for the documentation" @echo .PHONY: install @@ -232,3 +233,7 @@ celery-worker-status: .PHONY: celery-worker-dummy-task celery-worker-dummy-task: $(VIRTUAL_ENV)/bin/celery --app adhocracy-plus call dummy_task | awk '{print "celery-task-meta-"$$0}' | xargs redis-cli get | python3 -m json.tool + +.PHONY: docs +docs: + $(VIRTUAL_ENV)/bin/mkdocs serve diff --git a/changelog/_0002.md b/changelog/_0002.md new file mode 100644 index 000000000..8e66f8cd8 --- /dev/null +++ b/changelog/_0002.md @@ -0,0 +1,4 @@ +### Added + +- added a new make command `docs` to run the mkdocs server to read (and see live +changes to) the documentation