feat!(cli): Switch to cyclopts for CI

.github/workflows/reusable_docs.yml

@@ -52,6 +52,10 @@ jobs:
           git config --local user.email "github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
 
+      # Build docs
+      - name: Build docs
+        run: uv run mkdocs build
+
       # Deploy latest tag
       - name: Deploy docs
         if: ${{ inputs.deploy_latest }}

docs/included.py

@@ -1,12 +1,21 @@
 from typing import Optional, cast
 
 import mkdocs_gen_files
-from evalio.cli.ls import Kind, ls
+from evalio.cli.ls import ls
 from rich.table import Table
+import re
 
 
 def clean_cell(cell: str) -> str:
     """Clean a cell by removing unwanted characters."""
+    # Convert to links
+    if cell.startswith("[link"):
+        match = re.match(r"\[link=(.*?)\](.*?)\[/link\]", cell)
+        if match:
+            url, text = match.groups()
+            cell = f"[{text}]({url})"
+            return cell
+
     # Remove rich text formatting
     cell = cell.replace("[bright_black]", "").replace("[/bright_black]", "")
     # Remove line breaks
@@ -15,9 +24,6 @@ def clean_cell(cell: str) -> str:
     cell = cell.replace(" ", " ")
     # Non line breaking hyphen
     cell = cell.replace("-", "‑")
-    # Convert to links
-    if cell.startswith("http"):
-        cell = f"[link]({cell})"
 
     return cell.strip()
 
@@ -75,7 +81,7 @@ def rich_table_to_markdown(
     f.write(DATASETS)
     f.write("\n")
 
-    table = ls(Kind.datasets, show=False, show_hyperlinks=True)
+    table = ls("datasets", show=False)
     if table is not None:
         f.write(rich_table_to_markdown(table, skip_columns=["DL", "Size"]))
 
@@ -91,6 +97,6 @@ def rich_table_to_markdown(
     f.write(PIPELINES)
     f.write("\n")
 
-    table = ls(Kind.pipelines, show=False, show_hyperlinks=True)
+    table = ls("pipelines", show=False)
     if table is not None:
         f.write(rich_table_to_markdown(table))

docs/ref/cli.md

@@ -0,0 +1,6 @@
+# evalio
+
+::: cyclopts
+    module: evalio.cli:app
+    generate_toc: false
+    code_block_title: true

mkdocs.yml

@@ -41,6 +41,7 @@ theme:
 watch:
   - python/
   - cpp/
+  - docs/
 
 nav:
   - evalio:
@@ -69,11 +70,13 @@ plugins:
   search:
     lang: en
 
-  # autogenerate evalio ls & cli pages
+  # autogenerate evalio ls
   gen-files:
     scripts:
       - docs/included.py
-      - docs/ref/cli.py
+
+  # autogenerate cli docs
+  cyclopts:
 
   # Autogenerate docs from docstrings
   mkdocstrings:

pyproject.toml

@@ -7,6 +7,7 @@ description = "Evaluate Lidar-Inertial Odometry on public datasets"
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
+    "cyclopts==4.0",
     "asteval>=1.0.6",
     "distinctipy>=1.3.4",
     "gdown>=5.2.0",
@@ -17,7 +18,6 @@ dependencies = [
     "rapidfuzz>=3.12.2",
     "rosbags>=0.11.0",
     "tqdm>=4.66",
-    "typer>=0.15.3",
 ]
 keywords = [
     "lidar",
@@ -37,7 +37,7 @@ requires = ["scikit-build-core>=0.8", "nanobind>=2.9.2", "numpy"]
 build-backend = "scikit_build_core.build"
 
 [project.scripts]
-evalio = "evalio.cli:app"
+evalio = "evalio.cli:app.meta"
 
 # -------------- Tools -------------- #
 # building
@@ -104,3 +104,6 @@ stubPath = "python/typings"
 reportPrivateUsage = "none"
 reportConstantRedefinition = "none"
 reportUnnecessaryIsInstance = "none"
+
+[tool.uv.sources]
+cyclopts = { git = "https://github.com/BrianPugh/cyclopts.git", branch = "mkdocs-plugin" }