enh: add CLI to documentation using sphinx extension for argparse

Resolves: #392.
nipreps · Nov 28, 2023 · 8fdb439 · 8fdb439
1 parent 82977fc
commit 8fdb439
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -0,0 +1,8 @@
+Standalone command line usage
+=============================
+*SDCFlows* can execute fieldmap estimation from a BIDS-compliant dataset by using the *standalone command line interface*:
+
+.. argparse::
+   :module: sdcflows.cli.main
+   :func: _parser
+   :prog: sdcflows
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,6 +35,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
+    "sphinxarg.ext",
     "sphinxcontrib.apidoc",
     "nipype.sphinxext.apidoc",
     "nipype.sphinxext.plot_workflow",

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,5 +8,6 @@ Contents
 
     installation
     methods
+    cli
     api
     changes
diff --git a/setup.cfg b/setup.cfg
@@ -50,6 +50,7 @@ doc =
     pydot
     pydotplus
     sphinx
+    sphinx-argparse
     sphinxcontrib-apidoc
     sphinxcontrib-napoleon
 docs =
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,5 +8,6 @@ Contents @@
         installation
         methods
+        cli
         api
         changes