summaryrefslogtreecommitdiff
path: root/doc/pyspike.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/pyspike.rst')
-rw-r--r--doc/pyspike.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/pyspike.rst b/doc/pyspike.rst
new file mode 100644
index 0000000..39adea0
--- /dev/null
+++ b/doc/pyspike.rst
@@ -0,0 +1,38 @@
+pyspike package
+===============
+
+Submodules
+----------
+
+pyspike.distances module
+------------------------
+
+.. automodule:: pyspike.distances
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pyspike.function module
+-----------------------
+
+.. automodule:: pyspike.function
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pyspike.spikes module
+---------------------
+
+.. automodule:: pyspike.spikes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pyspike
+ :members:
+ :undoc-members:
+ :show-inheritance: