Separate and organize the various documentation sections.

[dunshire.git] / doc / source / user-api.rst

diff --git a/doc/source/user-api.rst b/doc/source/user-api.rst
new file mode 100644 (file)
index 0000000..22488f3
--- /dev/null
+++ b/doc/source/user-api.rst
@@ -0,0 +1,33 @@
+User API Documentation
+---------------------------
+
+You should only need to work with two modules, ``dunshire.cones`` and
+``dunshire.games``. For convenience, you can import everything from
+the ``dunshire`` package, and it will re-export what you need. For
+example,
+
+.. testcode::
+
+  from dunshire import *
+  K = IceCream(3)
+  L = [[1,-1,12],[0,1,22],[-17,1,0]]
+  e1 = [1,0.5,0.25]
+  e2 = [1,0.25,0.5]
+  G = SymmetricLinearGame(L,K,e1,e2)
+  G.solution()
+
+dunshire.cones module
+~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: dunshire.cones
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+dunshire.games module
+~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: dunshire.games
+    :members:
+    :undoc-members:
+    :show-inheritance: