Skip to content

Commit

Permalink
Makefile: add docs command to see documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
goapunk authored and m4ra committed Nov 13, 2024
1 parent 1ab924a commit 1dadf14
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
4 changes: 4 additions & 0 deletions changelog/_0002.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 1dadf14

Please sign in to comment.