starting on autodoc API reference

CityofSantaMonica · Oct 28, 2018 · 33d8a97 · 33d8a97
1 parent 965966c
commit 33d8a97
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 0 deletions.
diff --git a/Pipfile b/Pipfile
@@ -10,6 +10,7 @@ sphinx = "*"
 recommonmark = "*"
 requests = "*"
 sphinx-rtd-theme = "*"
+mds-provider = {path = "."}
 
 [requires]
 python_version = "3.6"
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,6 +8,7 @@ data.
     :maxdepth: 2
 
     examples/index
+    reference/index
 
 * :ref:`genindex`
 * :ref:`modindex`

diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -0,0 +1,11 @@
+API Reference
+==============================
+
+This is the ``mds-provider`` library API reference.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    mds
+    json
diff --git a/docs/reference/json.rst b/docs/reference/json.rst
@@ -0,0 +1,7 @@
+``mds.json`` Module
+============================
+
+Json module.
+
+.. automodule:: mds.json
+    :members:
diff --git a/docs/reference/mds.rst b/docs/reference/mds.rst
@@ -0,0 +1,6 @@
+``mds`` Module
+===================================
+
+.. automodule:: mds
+    :members:
+    :undoc-members: