summaryrefslogtreecommitdiff
path: root/doc/pyspike.rst
diff options
context:
space:
mode:
authorMario Mulansky <mario.mulansky@gmx.net>2015-02-03 15:13:22 +0100
committerMario Mulansky <mario.mulansky@gmx.net>2015-02-03 15:13:22 +0100
commitea61fc2ed03e42b3ea159b7ef7886d005c90e29f (patch)
tree923a10fadd6d381c8b42d93a036f9da95dcdc646 /doc/pyspike.rst
parent57b282e117c73913eed1f62dbe080544aadf4bbe (diff)
update docs to the structural changes
Diffstat (limited to 'doc/pyspike.rst')
-rw-r--r--doc/pyspike.rst47
1 files changed, 35 insertions, 12 deletions
diff --git a/doc/pyspike.rst b/doc/pyspike.rst
index 39adea0..6aa36e7 100644
--- a/doc/pyspike.rst
+++ b/doc/pyspike.rst
@@ -4,35 +4,58 @@ pyspike package
Submodules
----------
-pyspike.distances module
-------------------------
+pyspike.isi_distance module
+----------------------------------------
-.. automodule:: pyspike.distances
+.. automodule:: pyspike.isi_distance
:members:
:undoc-members:
:show-inheritance:
-pyspike.function module
------------------------
+pyspike.spike_distance module
+----------------------------------------
-.. automodule:: pyspike.function
+.. automodule:: pyspike.spike_distance
:members:
:undoc-members:
:show-inheritance:
-pyspike.spikes module
----------------------
+pyspike.spike_sync module
+----------------------------------------
-.. automodule:: pyspike.spikes
+.. automodule:: pyspike.spike_sync
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pyspike.PieceWiseConstFunc module
+----------------------------------------
+
+.. automodule:: pyspike.PieceWiseConstFunc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pyspike.PieceWiseLinFunc module
+----------------------------------------
+
+.. automodule:: pyspike.PieceWiseLinFunc
:members:
:undoc-members:
:show-inheritance:
+pyspike.DiscreteFunc module
+----------------------------------------
-Module contents
----------------
+.. automodule:: pyspike.DiscreteFunc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pyspike.spikes module
+----------------------------------------
-.. automodule:: pyspike
+.. automodule:: pyspike.spikes
:members:
:undoc-members:
:show-inheritance: