Added source dir to try and get RTD to generate module docs

whisk-ml · May 13, 2020 · 8c02ecf · 8c02ecf
1 parent 26d73cb
commit 8c02ecf
Show file tree

Hide file tree

Showing 21 changed files with 360 additions and 4 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = python -msphinx
 SPHINXPROJ    = whisk
-SOURCEDIR     = .
+SOURCEDIR     = source/
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/docs/authors.rst → docs/source/authors.rst b/docs/authors.rst → docs/source/authors.rst
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -83,7 +83,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the

diff --git a/docs/contributing.rst → docs/source/contributing.rst b/docs/contributing.rst → docs/source/contributing.rst
diff --git a/docs/history.rst → docs/source/history.rst b/docs/history.rst → docs/source/history.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
diff --git a/docs/installation.rst → docs/source/installation.rst b/docs/installation.rst → docs/source/installation.rst
diff --git a/docs/make.bat → docs/source/make.bat b/docs/make.bat → docs/source/make.bat
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+whisk
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   whisk
diff --git a/docs/readme.rst → docs/source/readme.rst b/docs/readme.rst → docs/source/readme.rst
diff --git a/docs/requirements.txt → docs/source/requirements.txt b/docs/requirements.txt → docs/source/requirements.txt
diff --git a/docs/usage.rst → docs/source/usage.rst b/docs/usage.rst → docs/source/usage.rst
diff --git a/docs/source/whisk.cli.commands.project.rst b/docs/source/whisk.cli.commands.project.rst
@@ -0,0 +1,62 @@
+whisk.cli.commands.project package
+==================================
+
+Submodules
+----------
+
+whisk.cli.commands.project.app module
+-------------------------------------
+
+.. automodule:: whisk.cli.commands.project.app
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.dvc module
+-------------------------------------
+
+.. automodule:: whisk.cli.commands.project.dvc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.notebook module
+------------------------------------------
+
+.. automodule:: whisk.cli.commands.project.notebook
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.package module
+-----------------------------------------
+
+.. automodule:: whisk.cli.commands.project.package
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.s3 module
+------------------------------------
+
+.. automodule:: whisk.cli.commands.project.s3
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.setup module
+---------------------------------------
+
+.. automodule:: whisk.cli.commands.project.setup
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: whisk.cli.commands.project
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/whisk.cli.commands.rst b/docs/source/whisk.cli.commands.rst
@@ -0,0 +1,29 @@
+whisk.cli.commands package
+==========================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    whisk.cli.commands.project
+
+Submodules
+----------
+
+whisk.cli.commands.create module
+--------------------------------
+
+.. automodule:: whisk.cli.commands.create
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: whisk.cli.commands
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/whisk.cli.rst b/docs/source/whisk.cli.rst
@@ -0,0 +1,37 @@
+whisk.cli package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    whisk.cli.commands
+
+Submodules
+----------
+
+whisk.cli.cli module
+--------------------
+
+.. automodule:: whisk.cli.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.whisk\_multi\_command module
+--------------------------------------
+
+.. automodule:: whisk.cli.whisk_multi_command
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: whisk.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/whisk.rst b/docs/source/whisk.rst
@@ -0,0 +1,61 @@
+whisk package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    whisk.cli
+
+Submodules
+----------
+
+whisk.dvc module
+----------------
+
+.. automodule:: whisk.dvc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.git module
+----------------
+
+.. automodule:: whisk.git
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.model\_stub module
+------------------------
+
+.. automodule:: whisk.model_stub
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.project module
+--------------------
+
+.. automodule:: whisk.project
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.whisk module
+------------------
+
+.. automodule:: whisk.whisk
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: whisk
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/whisk.cli.commands.project.rst b/docs/whisk.cli.commands.project.rst
@@ -0,0 +1,62 @@
+whisk.cli.commands.project package
+==================================
+
+Submodules
+----------
+
+whisk.cli.commands.project.app module
+-------------------------------------
+
+.. automodule:: whisk.cli.commands.project.app
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.dvc module
+-------------------------------------
+
+.. automodule:: whisk.cli.commands.project.dvc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.notebook module
+------------------------------------------
+
+.. automodule:: whisk.cli.commands.project.notebook
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.package module
+-----------------------------------------
+
+.. automodule:: whisk.cli.commands.project.package
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.s3 module
+------------------------------------
+
+.. automodule:: whisk.cli.commands.project.s3
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.commands.project.setup module
+---------------------------------------
+
+.. automodule:: whisk.cli.commands.project.setup
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: whisk.cli.commands.project
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/whisk.cli.commands.rst b/docs/whisk.cli.commands.rst
@@ -0,0 +1,29 @@
+whisk.cli.commands package
+==========================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    whisk.cli.commands.project
+
+Submodules
+----------
+
+whisk.cli.commands.create module
+--------------------------------
+
+.. automodule:: whisk.cli.commands.create
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: whisk.cli.commands
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/whisk.cli.rst b/docs/whisk.cli.rst
@@ -0,0 +1,37 @@
+whisk.cli package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    whisk.cli.commands
+
+Submodules
+----------
+
+whisk.cli.cli module
+--------------------
+
+.. automodule:: whisk.cli.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.cli.whisk\_multi\_command module
+--------------------------------------
+
+.. automodule:: whisk.cli.whisk_multi_command
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: whisk.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/whisk.rst b/docs/whisk.rst
@@ -1,13 +1,44 @@
 whisk package
 =============
 
+Subpackages
+-----------
+
+.. toctree::
+
+    whisk.cli
+
 Submodules
 ----------
 
-whisk.cli module
+whisk.dvc module
+----------------
+
+.. automodule:: whisk.dvc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.git module
 ----------------
 
-.. automodule:: whisk.cli
+.. automodule:: whisk.git
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.model\_stub module
+------------------------
+
+.. automodule:: whisk.model_stub
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+whisk.project module
+--------------------
+
+.. automodule:: whisk.project
     :members:
     :undoc-members:
     :show-inheritance: