use sphinx-click to document CLI

maxibor · Apr 27, 2020 · 39ea203 · 39ea203
1 parent 9a734d3
commit 39ea203
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 33 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -7,3 +7,4 @@ scipy>=1.4.1
 statsmodels>=0.11.0
 matplotlib>=3.1.1
 tqdm>=4.45.0
+sphinx-click>=2.3.2
diff --git a/docs/source/CLI.md b/docs/source/CLI.md
diff --git a/docs/source/CLI.rst b/docs/source/CLI.rst
@@ -0,0 +1,6 @@
+CLI
+===
+
+.. click:: pydamage.cli:cli
+  :prog: pydamage
+  :show-nested:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -39,6 +39,7 @@
     'sphinx.ext.githubpages',
     'sphinx.ext.napoleon',
     'sphinx.ext.mathjax',
+    'sphinx_click.ext',
     'recommonmark'
 ]
 

diff --git a/docs/source/introduction.md b/docs/source/introduction.md
@@ -32,3 +32,13 @@ python setup.py install
 ```bash
 pip install git+ssh://git@github.com/maxibor/pydamage.git
 ```
+
+## CLI help
+
+Command line interface help message
+
+```bash
+pydamage --help
+```
+
+See also [CLI](CLI)
diff --git a/pydamage/cli.py b/pydamage/cli.py
@@ -4,7 +4,6 @@
 from pydamage.main import analyze
 from pydamage import __version__
 
-
 @click.command()
 @click.version_option(__version__)
 @click.argument('bam', type=click.Path(exists=True))