docs: Use mkdocs-typer to generated documentation for CLI scripts

Note that the example from mkdocs-typer README no longer works
because of changes in how typer itself works.

docs/cli.md

@@ -0,0 +1,21 @@
+# CLI Reference
+
+This page provides documentation for PatchScope command line tools.
+
+
+[//]: # (see https://github.com/bruce-szalwinski/mkdocs-typer/issues/18)
+
+::: mkdocs-typer
+    :module: diffannotator.generate_patches
+    :command: app
+    :prog_name: diff-generate
+
+::: mkdocs-typer
+    :module: diffannotator.annotate
+    :command: app
+    :prog_name: diff-annotate
+
+::: mkdocs-typer
+    :module: diffannotator.gather_data
+    :command: app
+    :prog_name: diff-gather-stats

mkdocs.yml

@@ -12,6 +12,7 @@ nav:
   #- contributing: contributing.md
   #- authors: authors.md
   #- history: history.md
+  - CLI: cli.md
   - API: reference/
   - schema: schema.md
   - examples: examples.md
@@ -84,6 +85,7 @@ markdown_extensions:
       permalink: true
       slugify: !!python/name:pymdownx.slugs.uslugify
   - meta
+  - mkdocs-typer  # generate documentation for Typer command line applications
 plugins:
   - include-markdown  # including (embedding) Markdown files, by default within {% and %}
   - search:  # adds a search bar to the header; powered by lunr.js

pyproject.toml

@@ -67,6 +67,7 @@ doc = [
   "mkdocs-gen-files~=0.5.0",
   "mkdocs-literate-nav~=0.6.1",
   "mkdocs-section-index~=0.3.9",
+  "mkdocs-typer~=0.0.3",
   "mkdocs-material~=9.5.48",
   #"mike~=1.1.2",
   #"setuptools~=68.0",