cory/tildefriends
5
6
Fork 2
Code Issues 38 Pull Requests Actions Releases 33 Wiki Activity

docs: Auto-generate a usage.md from the command-line interface.
Some checks failed
Build Tilde Friends / Build-All (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Cory McWilliams
2025-06-18 19:00:13 -04:00
parent 94a79dd62c
commit 620db19936
3 changed files with 235 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
GNUmakefile
View File

@ -1483,6 +1483,18 @@ help: ## Display this help message.
.PHONY: help
.DEFAULT_GOAL := help
docs: debug
docs: ## Build HTML docs.
@echo '# CLI Usage' > docs/usage.md
@echo "## tildefriends -h" >> docs/usage.md
@echo '```' >> docs/usage.md
@out/debug/tildefriends -h >> docs/usage.md
@echo '```' >> docs/usage.md
@for command in $$(out/debug/tildefriends -h | grep -Po '[A-Za-z_]*(?= - )'); do
@ echo "## tildefriends $$command -h" >> docs/usage.md
@ echo '```' >> docs/usage.md
@ out/debug/tildefriends $$command -h >> docs/usage.md
@ echo '```' >> docs/usage.md
@done
@doxygen
.PHONY: docs