added basic docs setup

MaineKuehn · Jul 13, 2017 · 529f2a0 · 529f2a0
1 parent 772a7ce
commit 529f2a0
Show file tree

Hide file tree

Showing 8 changed files with 74 additions and 0 deletions.
diff --git a/build_docs.sh b/build_docs.sh
diff --git a/docs/source/api/graphi.compatibility.python2.rst b/docs/source/api/graphi.compatibility.python2.rst
@@ -0,0 +1,7 @@
+graphi\.compatibility\.python2 module
+=====================================
+
+.. automodule:: graphi.compatibility.python2
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/graphi.compatibility.python3.rst b/docs/source/api/graphi.compatibility.python3.rst
@@ -0,0 +1,7 @@
+graphi\.compatibility\.python3 module
+=====================================
+
+.. automodule:: graphi.compatibility.python3
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/graphi.compatibility.rst b/docs/source/api/graphi.compatibility.rst
@@ -0,0 +1,16 @@
+graphi\.compatibility package
+=============================
+
+.. automodule:: graphi.compatibility
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   graphi.compatibility.python2
+   graphi.compatibility.python3
+
diff --git a/docs/source/api/graphi.edge.rst b/docs/source/api/graphi.edge.rst
@@ -0,0 +1,7 @@
+graphi\.edge module
+===================
+
+.. automodule:: graphi.edge
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/graphi.graph.rst b/docs/source/api/graphi.graph.rst
@@ -0,0 +1,7 @@
+graphi\.graph module
+====================
+
+.. automodule:: graphi.graph
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/graphi.rst b/docs/source/api/graphi.rst
@@ -0,0 +1,23 @@
+graphi package
+==============
+
+.. automodule:: graphi
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    graphi.compatibility
+
+Submodules
+----------
+
+.. toctree::
+
+   graphi.edge
+   graphi.graph
+
diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst
@@ -0,0 +1,7 @@
+graphi
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   graphi