Merge pull request #515 from jrbourbeau/api-docs

Add command line API to docs

.circleci/config.yml

@@ -15,6 +15,7 @@ jobs:
       - restore_cache:
           keys:
             - cache-pip
+      - run: pip install --user -e .
       # Install the packages needed to build our documentation
       # This will depend on your particular package!
       - run: pip install --user -r docs/doc-requirements.txt

Pipfile

@@ -11,6 +11,7 @@ recommonmark = "*"
 alabaster = "*"
 Sphinx = ">=1.4,!=1.5.4"
 alabaster_jupyterhub = "*"
+sphinxcontrib-autoprogram = "*"
 
 [packages]
 repo2docker = {path=".", editable=true}

docs/doc-requirements.txt

@@ -4,3 +4,4 @@ sphinx>=1.4, !=1.5.4
 recommonmark
 alabaster
 alabaster_jupyterhub
+sphinxcontrib-autoprogram

docs/source/conf.py

@@ -33,7 +33,9 @@ import recommonmark.parser
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.extlinks']
+extensions = ['sphinx.ext.extlinks',
+              'sphinxcontrib.autoprogram',
+              ]
 
 extlinks = {
     'issue': ('https://github.com/jupyter/repo2docker/issues/%s', 'Issue #'),

docs/source/usage.rst

@@ -107,4 +107,12 @@ be used by docker directly.
 
      jupyter-repo2docker --no-build --debug https://github.com/norvig/pytudes
 
+
+Command line API
+================
+
+.. autoprogram:: repo2docker.__main__:argparser
+  :prog: jupyter-repo2docker
+
+
 .. _Pytudes: https://github.com/norvig/pytudes

repo2docker/__main__.py

@@ -37,7 +37,9 @@ def validate_image_name(image_name):
 
 def get_argparser():
     """Get arguments that may be used by repo2docker"""
-    argparser = argparse.ArgumentParser()
+    argparser = argparse.ArgumentParser(
+        description='Fetch a repository and build a container image',
+    )
 
     argparser.add_argument(
         '--config',
@@ -194,6 +196,8 @@ def get_argparser():
 
     return argparser
 
+argparser = get_argparser()
+
 
 def make_r2d(argv=None):
     if argv is None: