Allow sphinx documentation of CLI and fix CLI command for example

docs/cli.rst

@@ -6,7 +6,6 @@ ScoutBot CLI
    :caption: Contents:
 
 
-.. automodule:: scoutbot.scoutbot
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. click:: scoutbot.scoutbot:cli
+   :prog: scoutbot
+   :nested: full

docs/conf.py

@@ -37,6 +37,7 @@ extensions = [
     'sphinx.ext.viewcode',
     'sphinx.ext.imgmath',
     'sphinx.ext.napoleon',
+    'sphinx_click',
 ]
 
 intersphinx_mapping = {

requirements.optional.txt

@@ -13,5 +13,6 @@ pytest-random-order
 pytest-sugar
 pytest-xdist
 Sphinx>=5,<6
+sphinx-click
 sphinx_rtd_theme
 xdoctest

scoutbot/__init__.py

@@ -44,6 +44,11 @@ how the entire pipeline can be run on tiles or images, respectively.
         nms_thresh=agg_nms_thresh,
     )
 '''
+from os.path import exists
+
+import pooch
+import utool as ut
+
 from scoutbot import utils
 
 log = utils.init_logging()
@@ -139,3 +144,23 @@ def pipeline(
     )
 
     return detects
+
+
+def example():
+    TEST_IMAGE = 'scout.example.jpg'
+    TEST_IMAGE_HASH = (
+        '786a940b062a90961f409539292f09144c3dbdbc6b6faa64c3e764d63d55c988'  # NOQA
+    )
+
+    img_filepath = pooch.retrieve(
+        url=f'https://wildbookiarepository.azureedge.net/data/{TEST_IMAGE}',
+        known_hash=TEST_IMAGE_HASH,
+        progressbar=True,
+    )
+    assert exists(img_filepath)
+
+    log.info(f'Running pipeline on image: {img_filepath}')
+
+    detects = pipeline(img_filepath)
+
+    log.info(ut.repr3(detects))

scoutbot/scoutbot.py

@@ -7,7 +7,6 @@ import json
 from os.path import exists
 
 import click
-import pooch
 import utool as ut
 
 import scoutbot
@@ -106,23 +105,7 @@ def example():
     """
     Run a test of the pipeline on an example image
     """
-    TEST_IMAGE = 'scout.example.jpg'
-    TEST_IMAGE_HASH = (
-        '786a940b062a90961f409539292f09144c3dbdbc6b6faa64c3e764d63d55c988'  # NOQA
-    )
-
-    img_filepath = pooch.retrieve(
-        url=f'https://wildbookiarepository.azureedge.net/data/{TEST_IMAGE}',
-        known_hash=TEST_IMAGE_HASH,
-        progressbar=True,
-    )
-    assert exists(img_filepath)
-
-    log.info(f'Running pipeline on image: {img_filepath}')
-
-    detects = scoutbot.pipeline(img_filepath)
-
-    log.info(ut.repr3(detects))
+    scoutbot.example()
 
 
 @click.group()