add cli section in docs

LucaMarconato · LucaMarconato · commit fe30019bd592 · 2025-01-13T20:38:46.000+01:00
diff --git a/docs/api.md b/docs/api.md
@@ -1,5 +1,7 @@
 # API
 
+This section documents the Application Programming Interface (API) for the `spatialdata_io` package.
+
 ```{eval-rst}
 .. module:: spatialdata_io
 ```
diff --git a/docs/cli.md b/docs/cli.md
@@ -0,0 +1,9 @@
+# CLI
+
+This section documents the Command Line Interface (CLI) for the `spatialdata_io` package.
+
+```{eval-rst}
+.. click:: spatialdata_io.__main__:cli
+    :prog: spatialdata_io
+    :nested: full
+```
diff --git a/docs/conf.py b/docs/conf.py
@@ -57,6 +57,7 @@
     "sphinx_autodoc_typehints",
     "sphinx.ext.mathjax",
     "IPython.sphinxext.ipython_console_highlighting",
+    "sphinx_click",
     *[p.stem for p in (HERE / "extensions").glob("*.py")],
 ]
 
diff --git a/docs/index.md b/docs/index.md
@@ -7,6 +7,7 @@
 :maxdepth: 1
 
 api.md
+cli.md
 changelog.md
 template_usage.md
 contributing.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -51,6 +51,7 @@ doc = [
     "sphinxcontrib-bibtex>=1.0.0",
     "sphinx-autodoc-typehints",
     "sphinx-design",
+    "sphinx-click",
     # For notebooks
     "ipython>=8.6.0",
     "sphinx-copybutton",

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,7 @@`
`57`	`57`	`"sphinx_autodoc_typehints",`
`58`	`58`	`"sphinx.ext.mathjax",`
`59`	`59`	`"IPython.sphinxext.ipython_console_highlighting",`
	`60`	`+ "sphinx_click",`
`60`	`61`	`[p.stem for p in (HERE / "extensions").glob(".py")],`
`61`	`62`	`]`
`62`	`63`