Merge pull request #33 from pganssle/doc_reorg

pganssle · web-flow · commit 10535712142a · 2018-05-03T16:27:52.000-04:00
Reorganize documentation, add inspect
diff --git a/changelog.d/33.doc.rst b/changelog.d/33.doc.rst
@@ -0,0 +1 @@
+Added section for API documentation, including documentation for the inspect submodule.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,10 @@
+==========================
+Variants API Documentation
+==========================
+
+.. toctree::
+    :maxdepth: 2
+
+    variants
+    variants.inspect <inspect>
+
diff --git a/docs/api/inspect.rst b/docs/api/inspect.rst
@@ -0,0 +1,6 @@
+=======
+inspect
+=======
+
+.. automodule:: variants.inspect
+    :members:
diff --git a/docs/api/variants.rst b/docs/api/variants.rst
@@ -0,0 +1,6 @@
+========
+variants
+========
+
+.. automodule:: variants
+    :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -21,6 +21,11 @@ Contents:
    authors
    changelog
 
+.. toctree::
+    :maxdepth: 2
+
+    API Documentation <api/index.rst>
+
 Indices and tables
 ==================
 
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -7,4 +7,5 @@ decorator, which will add the ``variant`` method to your original function.
 
 .. module:: variants
 .. autofunction:: variants.primary
+    :noindex:
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Added section for API documentation, including documentation for the inspect submodule.`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +=======
 +inspect
 +=======
++
 +.. automodule:: variants.inspect
 +    :members:
Original file line number	Diff line number	Diff line change
@@ -7,4 +7,5 @@ decorator, which will add the ``variant`` method to your original function.
`7`	`7`
`8`	`8`	`.. module:: variants`
`9`	`9`	`.. autofunction:: variants.primary`
	`10`	`+ :noindex:`
`10`	`11`