Add auto-generated docs for command line api

data-workspaces · Mar 19, 2019 · baf5e5d · baf5e5d
1 parent 19b3848
commit baf5e5d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/docs/commands.rst b/docs/commands.rst
@@ -3,3 +3,7 @@
 3. Command Reference
 ====================
 In this section, we describe the full command line interface for Data Workspaces.
+
+.. click:: dataworkspaces.dws:cli
+   :prog: dws
+   :show-nested:
diff --git a/docs/conf.py b/docs/conf.py
@@ -41,6 +41,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
+    'sphinx_click.ext'
 ]
 
 autodoc_mock_imports=['click']

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+# requirements for building the doc
+sphinx_rtd_theme
+sphinx-click