From cc8ae1974454307de4c69d9bb2a860538f0adfef Mon Sep 17 00:00:00 2001 From: Mario Mulansky Date: Mon, 27 Apr 2015 17:27:24 +0200 Subject: updated docs --- doc/pyspike.rst | 54 +++++++++++++++++++++++++++++------------------------- 1 file changed, 29 insertions(+), 25 deletions(-) (limited to 'doc') diff --git a/doc/pyspike.rst b/doc/pyspike.rst index 6aa36e7..a6dc1a0 100644 --- a/doc/pyspike.rst +++ b/doc/pyspike.rst @@ -1,60 +1,64 @@ pyspike package =============== -Submodules ----------- -pyspike.isi_distance module +Classes ---------------------------------------- -.. automodule:: pyspike.isi_distance +SpikeTrain +........................................ +.. automodule:: pyspike.SpikeTrain :members: :undoc-members: :show-inheritance: -pyspike.spike_distance module ----------------------------------------- - -.. automodule:: pyspike.spike_distance +PieceWiseConstFunc +........................................ +.. automodule:: pyspike.PieceWiseConstFunc :members: :undoc-members: :show-inheritance: -pyspike.spike_sync module ----------------------------------------- - -.. automodule:: pyspike.spike_sync +PieceWiseLinFunc +........................................ +.. automodule:: pyspike.PieceWiseLinFunc :members: :undoc-members: :show-inheritance: -pyspike.PieceWiseConstFunc module ----------------------------------------- - -.. automodule:: pyspike.PieceWiseConstFunc +DiscreteFunc +........................................ +.. automodule:: pyspike.DiscreteFunc :members: :undoc-members: :show-inheritance: -pyspike.PieceWiseLinFunc module ----------------------------------------- +Functions +---------- -.. automodule:: pyspike.PieceWiseLinFunc +ISI-distance +........................................ +.. automodule:: pyspike.isi_distance :members: :undoc-members: :show-inheritance: -pyspike.DiscreteFunc module ----------------------------------------- - -.. automodule:: pyspike.DiscreteFunc +SPIKE-distance +........................................ +.. automodule:: pyspike.spike_distance :members: :undoc-members: :show-inheritance: -pyspike.spikes module ----------------------------------------- +SPIKE-synchronization +........................................ +.. automodule:: pyspike.spike_sync + :members: + :undoc-members: + :show-inheritance: +Helper functions +........................................ .. automodule:: pyspike.spikes :members: :undoc-members: -- cgit v1.2.3