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 6e3c479547df2fbbd5605c8646cbd7fe9e8eedad Author: Alexandre Gramfort <[email protected]> Date: Fri Mar 23 09:21:37 2012 +0100 DOC : fix doc reference page --- doc/source/conf.py | 2 +- doc/source/mne-python.rst | 2 +- doc/source/python_reference.rst | 56 ++++++++++++++++++++++++++++++----------- doc/source/whats_new.rst | 2 ++ mne/artifacts/__init__.py | 3 +++ 5 files changed, 49 insertions(+), 16 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index ffb4e15..9ff614e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -16,7 +16,7 @@ import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.append(os.path.abspath('../mne')) +sys.path.append(os.path.abspath('../../mne')) sys.path.append(os.path.abspath('../sphinxext')) import mne diff --git a/doc/source/mne-python.rst b/doc/source/mne-python.rst index c9c386c..7d79491 100644 --- a/doc/source/mne-python.rst +++ b/doc/source/mne-python.rst @@ -8,8 +8,8 @@ MNE with Python :maxdepth: 1 getting_started.rst - auto_examples/index.rst python_tutorial.rst + auto_examples/index.rst python_reference.rst whats_new.rst gitwash/index.rst diff --git a/doc/source/python_reference.rst b/doc/source/python_reference.rst index 2807742..cf48135 100644 --- a/doc/source/python_reference.rst +++ b/doc/source/python_reference.rst @@ -4,8 +4,6 @@ Reference This is the classes and functions reference of mne-python. -.. currentmodule:: mne.fiff - .. automodule:: mne :no-members: :no-inherited-members: @@ -26,6 +24,8 @@ Classes reference Functions reference =================== +.. currentmodule:: mne + .. autosummary:: :toctree: generated/ :template: function.rst @@ -47,19 +47,16 @@ Functions reference write_stc read_w write_w + fiff.pick_types + fiff.pick_channels + fiff.pick_types_evoked + fiff.pick_channels_regexp + fiff.pick_channels_forward + fiff.pick_types_forward -.. 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 +.. automodule:: mne.minimum_norm + :no-members: + :no-inherited-members: .. currentmodule:: mne.minimum_norm @@ -76,6 +73,10 @@ Functions reference source_band_induced_power source_induced_power +.. automodule:: mne.stats + :no-members: + :no-inherited-members: + .. currentmodule:: mne.stats .. autosummary:: @@ -87,3 +88,30 @@ Functions reference permutation_cluster_1samp_test fdr_correction bonferroni_correction + +.. automodule:: mne.artifacts + :no-members: + :no-inherited-members: + +.. currentmodule:: mne.artifacts + +.. autosummary:: + :toctree: generated/ + :template: function.rst + + find_eog_events + find_ecg_events + +.. automodule:: mne.time_frequency + :no-members: + :no-inherited-members: + +.. currentmodule:: mne.time_frequency + +.. autosummary:: + :toctree: generated/ + :template: function.rst + + induced_power + single_trial_power + compute_raw_psd diff --git a/doc/source/whats_new.rst b/doc/source/whats_new.rst index feadf7b..82865da 100644 --- a/doc/source/whats_new.rst +++ b/doc/source/whats_new.rst @@ -31,6 +31,8 @@ Changelog - Covariance matrix computation with multiple event types by `Martin Luessi`_. + - New tutorial in the documentation and new classes and functions reference page by `Alex Gramfort`_. + Version 0.2 ----------- diff --git a/mne/artifacts/__init__.py b/mne/artifacts/__init__.py index 19a3252..3be0dd2 100644 --- a/mne/artifacts/__init__.py +++ b/mne/artifacts/__init__.py @@ -1,2 +1,5 @@ +"""Artifacts finding/correction related functions +""" + from .eog import find_eog_events from .ecg import find_ecg_events -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/python-mne.git _______________________________________________ debian-med-commit mailing list [email protected] http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/debian-med-commit
