[med-svn] [python-mne] 124/353: ENH : first attemps to add class/function refence to the doc

[Yaroslav Halchenko]

This is an automated email from the git hooks/post-receive script.

yoh pushed a commit to tag 0.4
in repository python-mne.

commit 0ce34a2167e7cda1690ddee3038a8c34ecc61eb4
Author: Alexandre Gramfort <alexandre.gramfort at inria.fr>
Date:   Tue Mar 20 22:27:35 2012 +0100

    ENH : first attemps to add class/function refence to the doc
---
 doc/source/_templates/class.rst    | 12 ++++++
 doc/source/_templates/function.rst |  8 ++++
 doc/source/mne-python.rst          |  1 +
 doc/source/python_reference.rst    | 85 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 106 insertions(+)

diff --git a/doc/source/_templates/class.rst b/doc/source/_templates/class.rst
new file mode 100644
index 0000000..6e17cfa
--- /dev/null
+++ b/doc/source/_templates/class.rst
@@ -0,0 +1,12 @@
+{{ fullname }}
+{{ underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+   .. automethod:: __init__
+   {% endblock %}
+
+
diff --git a/doc/source/_templates/function.rst b/doc/source/_templates/function.rst
new file mode 100644
index 0000000..317222f
--- /dev/null
+++ b/doc/source/_templates/function.rst
@@ -0,0 +1,8 @@
+{{ fullname }}
+{{ underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ objname }}
+
+
diff --git a/doc/source/mne-python.rst b/doc/source/mne-python.rst
index ae60221..5199eca 100644
--- a/doc/source/mne-python.rst
+++ b/doc/source/mne-python.rst
@@ -9,6 +9,7 @@ MNE with Python
 
    getting_started.rst
    python_tutorial.rst
+   python_reference.rst
    auto_examples/index.rst
    whats_new.rst
    gitwash/index.rst
diff --git a/doc/source/python_reference.rst b/doc/source/python_reference.rst
new file mode 100644
index 0000000..8b73446
--- /dev/null
+++ b/doc/source/python_reference.rst
@@ -0,0 +1,85 @@
+=========
+Reference
+=========
+
+This is the classes and functions reference of mne-python.
+
+.. _mne_ref:
+
+.. automodule:: mne
+   :no-members:
+   :no-inherited-members:
+
+Classes reference
+=================
+
+.. currentmodule:: mne
+
+.. autosummary::
+   :toctree: generated/
+   :template: class.rst
+
+   fiff.Raw
+   fiff.Evoked
+   Epochs
+   Covariance
+   SourceEstimate
+
+Functions reference
+===================
+
+.. autosummary::
+   :toctree: generated/
+   :template: function.rst
+
+   read_cov
+   write_cov
+
+   label_time_courses
+   read_label
+   label_sign_flip
+   write_label
+   stc_to_label
+
+   read_bem_surfaces
+   read_surface
+   write_bem_surface
+
+   read_source_spaces
+
+   save_stc_as_volume
+
+   morph_data
+
+   read_stc
+   write_stc
+   read_w
+   write_w
+
+.. currentmodule:: mne.fiff
+
+.. autosummary::
+  :toctree: generated/
+  :template: function.rst
+
+   pick_types
+   pick_channels
+   pick_types_evoked
+   pick_channels_regexp
+   pick_channels_forward
+   pick_types_forward
+
+.. currentmodule:: mne.minimum_norm
+
+.. autosummary::
+   :toctree: generated/
+   :template: function.rst
+
+   read_inverse_operator
+   apply_inverse
+   apply_inverse_raw
+   make_inverse_operator
+   apply_inverse_epochs
+   write_inverse_operator
+   source_band_induced_power
+   source_induced_power

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/python-mne.git