DOC: Fill holes, simplify

datalad · May 20, 2018 · 201a23f · 201a23f
1 parent 20ee17c
commit 201a23f
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 24 deletions.
diff --git a/datalad_container/containers_add.py b/datalad_container/containers_add.py
@@ -1,3 +1,4 @@
+"""Add a container environment to a dataset"""
 
 __docformat__ = 'restructuredtext'
 

diff --git a/datalad_container/containers_list.py b/datalad_container/containers_list.py
@@ -1,3 +1,4 @@
+"""List known container environments of a dataset"""
 
 __docformat__ = 'restructuredtext'
 

diff --git a/datalad_container/containers_remove.py b/datalad_container/containers_remove.py
@@ -1,3 +1,4 @@
+"""Remove a container environment from a dataset"""
 
 __docformat__ = 'restructuredtext'
 

diff --git a/datalad_container/containers_run.py b/datalad_container/containers_run.py
@@ -1,3 +1,4 @@
+"""Drop-in replacement for `datalad run` for command execution in a container"""
 
 __docformat__ = 'restructuredtext'
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,15 +7,29 @@ DataLad extension module for containerized environments
    changelog
    acknowledgements
 
-API
-===
+Command manuals
+===============
 
 .. toctree::
    :maxdepth: 1
 
    generated/man/datalad-containers-add
+   generated/man/datalad-containers-remove
    generated/man/datalad-containers-list
-   modref
+   generated/man/datalad-containers-run
+
+
+Python module reference
+=======================
+
+.. currentmodule:: datalad_container
+.. autosummary::
+   :toctree: generated
+
+   containers_add
+   containers_remove
+   containers_list
+   containers_run
 
 
 Indices and tables

diff --git a/docs/source/modref.rst b/docs/source/modref.rst
diff --git a/setup_support.py b/setup_support.py
@@ -14,6 +14,12 @@
 import datetime
 import formatters as fmt
 
+cmdline_command_names = (
+    'containers-list',
+    'containers-add',
+    'containers-remove',
+    'containers-run',
+)
 
 def _path_rel2file(p):
     return opj(dirname(__file__), p)
@@ -91,7 +97,7 @@ def run(self):
                                 (fmt.RSTManPageFormatter, self.rstpath, 'rst')):
             if not os.path.exists(opath):
                 os.makedirs(opath)
-            for cmdname in ('containers-list', 'containers-add'):
+            for cmdname in cmdline_command_names:
                 p = self._parser[cmdname]
                 cmdname = "{0}{1}".format(
                     'datalad-' if cmdname != 'datalad' else '',