📝(api) add CLI documentation

Automate CLI documentation.
openfun · Jul 18, 2024 · b43488f · b43488f
1 parent 72b7bef
commit b43488f
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/docs/cli.md b/docs/cli.md
@@ -0,0 +1,6 @@
+# Commands
+
+::: mkdocs-click
+    :module: warren.cli
+    :command: cli
+    :depth: 1
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
@@ -28,6 +28,7 @@ license = {file = "LICENSE.md"}
 keywords = ["Analytics", "xAPI", "LRS", "LTI"]
 dependencies = [
     "mike==2.1.1",
+    "mkdocs-click==0.8.1",
     "mkdocs-material==9.5.27",
     "mkdocs==1.6.0",
     "neoteroi-mkdocs==1.0.5",

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -49,6 +49,7 @@ theme:
 markdown_extensions:
   - admonition
   - attr_list
+  - mkdocs_click
   - smarty
   - toc:
       permalink: True
@@ -71,6 +72,7 @@ markdown_extensions:
 
 nav:
   - "Warren": index.md
+  - "CLI": cli.md
   - "Plugins": plugins.md
   - "Warren-TdBP": tdbp.md
   - "Contributing": contribute.md