Skip to content

Commit 81e7e33

Browse files
committed
📝(api) add CLI documentation
Automate CLI documentation.
1 parent 46c05f3 commit 81e7e33

3 files changed

Lines changed: 10 additions & 0 deletions

File tree

docs/cli.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Commands
2+
3+
::: mkdocs-click
4+
:module: warren.cli
5+
:command: cli
6+
:depth: 1

docs/pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,12 @@ license = {file = "LICENSE.md"}
2828
keywords = ["Analytics", "xAPI", "LRS", "LTI"]
2929
dependencies = [
3030
"mike==2.0.0",
31+
"mkdocs-click==0.8.1",
3132
"mkdocs-material==9.5.6",
3233
"mkdocs==1.5.3",
3334
"neoteroi-mkdocs==1.0.4",
3435
"pymdown-extensions==10.7",
36+
"warren-api==0.1.0",
3537
]
3638

3739
[project.urls]

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ theme:
4949
markdown_extensions:
5050
- admonition
5151
- attr_list
52+
- mkdocs_click
5253
- smarty
5354
- toc:
5455
permalink: True
@@ -71,6 +72,7 @@ markdown_extensions:
7172

7273
nav:
7374
- "Warren": index.md
75+
- "CLI": cli.md
7476
- "Plugins": plugins.md
7577
- "Contributing": contribute.md
7678
- "About the project":

0 commit comments

Comments
 (0)