Skip to content

Commit bf31895

Browse files
committed
make: generate man and markdown files in docs/
1 parent 941233e commit bf31895

File tree

4 files changed

+1217
-1
lines changed

4 files changed

+1217
-1
lines changed

Makefile

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,15 @@ sqlc-check: sqlc
170170
@$(call print, "Verifying sql code generation.")
171171
if test -n "$$(git status --porcelain '*.go')"; then echo "SQL models not properly generated!"; git status --porcelain '*.go'; exit 1; fi
172172

173+
docs: build
174+
@$(call print, "Building man and markdown files in docs/")
175+
./loop-debug man > docs/loop.1
176+
./loop-debug markdown > docs/loop.md
177+
178+
docs-check: docs
179+
@$(call print, "Verifying man and markdown files in docs/")
180+
if test -n "$$(git status --porcelain '*.go')"; then echo "Man and markdown files not properly generated!"; git status --porcelain '*.go'; exit 1; fi
181+
173182
fsm:
174183
@$(call print, "Generating state machine docs")
175184
./scripts/fsm-generate.sh;

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ loop in <amt_in_satoshis>
6565
```
6666

6767
### More info
68-
For more information about using Loop checkout our [Loop FAQs](./docs/faqs.md).
68+
69+
- [Loop FAQs](./docs/faqs.md)
70+
- [Loop CLI manual](./docs/loop.md)
6971

7072
## Development
7173

0 commit comments

Comments
 (0)