Skip to content

Commit e1f7621

Browse files
committed
Add docs generation to project
1 parent fddf4ce commit e1f7621

File tree

4 files changed

+19
-1
lines changed

4 files changed

+19
-1
lines changed

.release-it.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"hooks": {
99
"after:bump": "npx auto-changelog -p && git add CHANGELOG.md",
1010
"before:init": "just clean",
11-
"after:github:release": "just clean",
11+
"after:github:release": "just docs-release && just clean",
1212
"before:release": "just build"
1313
},
1414
"npm": {

Justfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,9 @@ template-update:
5353

5454
readme:
5555
.config/templating.sh
56+
57+
docs:
58+
uvx --with mkdocs-click --with . mkdocs serve
59+
60+
docs-release:
61+
uvx --with mkdocs-click --with . mkdocs gh-deploy

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# CLI Reference
2+
3+
This page provides documentation for our command line tools.
4+
5+
::: mkdocs-click
6+
:module: runbook.cli
7+
:command: cli

mkdocs.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
site_name: Runbook
2+
theme: readthedocs
3+
4+
markdown_extensions:
5+
- mkdocs-click

0 commit comments

Comments
 (0)