add commands docs

carderne · Aug 27, 2024 · 8843e76 · 8843e76
1 parent 38218f2
commit 8843e76
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 21 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -27,5 +27,6 @@ jobs:
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material 
-      - run: mkdocs gh-deploy --force
+      - run: pip install uv
+      - run: uv sync --python-preference=system
+      - run: uv run mkdocs gh-deploy --force
diff --git a/docs/commands.md b/docs/commands.md
@@ -0,0 +1,5 @@
+# CLI Commands
+
+::: mkdocs-typer
+    :module: una.cli
+    :command: app
diff --git a/docs/install.md b/docs/install.md
@@ -1,5 +1,5 @@
 # Installation
-The CLI tool isn't strictly necessary, as all the stuff that lets the monorepo builds work is in the separate (and tiny) [hatch-una](plugins/hatch) package.
+The CLI tool isn't strictly necessary, as all the stuff that lets the monorepo builds work is in the separate (and tiny) [hatch-una](https://github.com/carderne/una/tree/main/plugins/hatch) package.
 But you will likely struggle to manage your monorepo without the tool!
 
 So you may as well install it:

diff --git a/docs/usage.md b/docs/usage.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -22,13 +22,16 @@ theme:
     - navigation.instant
     - navigation.sections
 
+markdown_extensions:
+  - mkdocs-typer
+
 nav:
   - Home:
     - About: index.md
     - Quickstart: quickstart.md
   - Walkthrough:
     - Install: install.md
-    - Usage: usage.md
+    - Commands: commands.md
     - Build: build.md
     - Packages: packages.md
   - Integration:

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,6 +4,7 @@ dev-dependencies = [
     "basedpyright >= 1.15.2",
     "mkdocs-material >= 9.5.31",
     "ruff >= 0.6.2",
+    "mkdocs-typer>=0.0.3",
 ]
 
 [tool.uv.workspace]

diff --git a/uv.lock b/uv.lock