Skip to content

Commit 00a5851

Browse files
committed
docs: CLI reference
autogenerate with mkdocs-click
1 parent c23f12f commit 00a5851

File tree

5 files changed

+40
-0
lines changed

5 files changed

+40
-0
lines changed

docs/reference/cli/info.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# `compiler-admin info`
2+
3+
<!-- prettier-ignore -->
4+
::: mkdocs-click
5+
:module: compiler_admin.main
6+
:command: info
7+
:depth: 1
8+
:prog_name: compiler-admin info

docs/reference/cli/init.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# `compiler-admin init`
2+
3+
<!-- prettier-ignore -->
4+
::: mkdocs-click
5+
:module: compiler_admin.main
6+
:command: init
7+
:depth: 1
8+
:prog_name: compiler-admin init

docs/reference/cli/time.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# `compiler-admin time`
2+
3+
<!-- prettier-ignore -->
4+
::: mkdocs-click
5+
:module: compiler_admin.main
6+
:command: time
7+
:depth: 1
8+
:prog_name: compiler-admin time
9+
:list_subcommands: True

docs/reference/cli/user.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# `compiler-admin user`
2+
3+
<!-- prettier-ignore -->
4+
::: mkdocs-click
5+
:module: compiler_admin.main
6+
:command: user
7+
:depth: 1
8+
:prog_name: compiler-admin user
9+
:list_subcommands: True

mkdocs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ site_url: https://docs.compiler.la/compiler-admin
55

66
nav:
77
- Home: index.md
8+
- Reference:
9+
- CLI Reference:
10+
- init: reference/cli/init.md
11+
- info: reference/cli/info.md
12+
- time: reference/cli/time.md
13+
- user: reference/cli/user.md
814
- Explanation:
915
- Core Concepts: explanation/concepts.md
1016
- Architecture: explanation/architecture.md

0 commit comments

Comments
 (0)