diff options
| author | Mario Mulansky <mario.mulansky@gmx.net> | 2015-02-03 15:13:22 +0100 |
|---|---|---|
| committer | Mario Mulansky <mario.mulansky@gmx.net> | 2015-02-03 15:13:22 +0100 |
| commit | ea61fc2ed03e42b3ea159b7ef7886d005c90e29f (patch) | |
| tree | 923a10fadd6d381c8b42d93a036f9da95dcdc646 /doc | |
| parent | 57b282e117c73913eed1f62dbe080544aadf4bbe (diff) | |
update docs to the structural changes
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 4 | ||||
| -rw-r--r-- | doc/pyspike.rst | 47 |
2 files changed, 37 insertions, 14 deletions
diff --git a/doc/conf.py b/doc/conf.py index 48ebc7e..5427bb1 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -57,7 +57,7 @@ master_doc = 'index' # General information about the project. project = u'PySpike' -copyright = u'2014, Mario Mulansky' +copyright = u'2014-2015, Mario Mulansky' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -254,7 +254,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ ('index', 'PySpike', u'PySpike Documentation', - u'Mario Mulansky', 'PySpike', 'One line description of project.', + u'Mario Mulansky', 'PySpike', 'Measure of spike train synchrony.', 'Miscellaneous'), ] 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: |