add api to docs

MSLNZ · Jul 22, 2017 · e14b6f2 · e14b6f2
1 parent 8e17729
commit e14b6f2
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 0 deletions.
diff --git a/docs/_api/msl.qt.prompt.rst b/docs/_api/msl.qt.prompt.rst
@@ -0,0 +1,7 @@
+msl\.qt\.prompt module
+======================
+
+.. automodule:: msl.qt.prompt
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/_api/msl.qt.rst b/docs/_api/msl.qt.rst
@@ -0,0 +1,15 @@
+msl\.qt package
+===============
+
+.. automodule:: msl.qt
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   msl.qt.prompt
+
diff --git a/docs/_api/msl.rst b/docs/_api/msl.rst
@@ -0,0 +1,15 @@
+msl package
+===========
+
+.. automodule:: msl
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    msl.qt
+
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,25 @@
+.. _api:
+
+========================
+MSL-Qt API Documentation
+========================
+
+The root package is
+
+.. autosummary::
+
+    msl.qt
+
+which has the following modules
+
+.. autosummary::
+
+   msl.qt.prompt
+
+
+Package Structure
+-----------------
+
+.. toctree::
+
+   _api/msl
diff --git a/docs/index.rst b/docs/index.rst
@@ -12,6 +12,7 @@ Contents
    :maxdepth: 2
 
    Install <install>
+   API <api>
    License <license>
    Authors <authors>
    Release Notes <changelog>