DOC: adding cli docs

ImagingDataCommons · Aug 1, 2024 · 805b6de · 805b6de
1 parent 5df9c79
commit 805b6de
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -15,6 +15,7 @@
     "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
     "sphinx_copybutton",
+    "sphinx_click",
 ]
 
 source_suffix = [".rst", ".md"]

diff --git a/docs/index.md b/docs/index.md
@@ -81,3 +81,11 @@ api/idc_index
 - {ref}`genindex`
 - {ref}`modindex`
 - {ref}`search`
+
+## Command line tools
+
+```
+.. click:: groups.cli:cli
+  :prog: cli
+  :nested: full
+```
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,6 +41,7 @@ dependencies = [
   "pyarrow",
   "requests",
   "s5cmd",
+  "sphinx-click",
   "tqdm"
 ]