Skip to content

Commit e957233

Browse files
drammockdrammock
committed
split API so it gets sidebar links [circle full]
1 parent 7201062 commit e957233

25 files changed

+1097
-1087
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ mne/viz/_brain/tests/.ipynb_checkpoints
5151

5252
dist/
5353
doc/_build/
54+
doc/api/generated/
5455
doc/generated/
5556
doc/auto_examples/
5657
doc/auto_tutorials/

‎doc/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ help:
3434
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
3535

3636
clean:
37-
-rm -rf _build auto_examples auto_tutorials generated *.stc *.fif *.nii.gz
37+
-rm -rf _build auto_examples auto_tutorials generated api/generated *.stc *.fif *.nii.gz
3838

3939
html_stable:
4040
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html_stable

‎doc/api/connectivity.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
Connectivity Estimation
3+
=======================
4+
5+
:py:mod:`mne.connectivity`:
6+
7+
.. automodule:: mne.connectivity
8+
:no-members:
9+
:no-inherited-members:
10+
11+
.. currentmodule:: mne.connectivity
12+
13+
.. autosummary::
14+
:toctree: generated/
15+
16+
degree
17+
envelope_correlation
18+
phase_slope_index
19+
seed_target_indices
20+
spectral_connectivity
21+
22+
23+
.. _api_reference_statistics:

‎doc/api/covariance.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
Covariance computation
3+
======================
4+
5+
.. currentmodule:: mne
6+
7+
.. autosummary::
8+
:toctree: generated/
9+
10+
Covariance
11+
compute_covariance
12+
compute_raw_covariance
13+
cov.compute_whitener
14+
cov.prepare_noise_cov
15+
cov.regularize
16+
compute_rank
17+
make_ad_hoc_cov
18+
read_cov
19+
write_cov

‎doc/api/creating_from_arrays.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
Creating data objects from arrays
3+
=================================
4+
5+
.. currentmodule:: mne
6+
7+
.. autosummary::
8+
:toctree: generated/
9+
10+
EvokedArray
11+
EpochsArray
12+
io.RawArray
13+
create_info

‎doc/api/datasets.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
Datasets
3+
========
4+
5+
.. currentmodule:: mne.datasets
6+
7+
:py:mod:`mne.datasets`:
8+
9+
.. automodule:: mne.datasets
10+
:no-members:
11+
:no-inherited-members:
12+
13+
.. autosummary::
14+
:toctree: generated/
15+
16+
brainstorm.bst_auditory.data_path
17+
brainstorm.bst_resting.data_path
18+
brainstorm.bst_raw.data_path
19+
eegbci.load_data
20+
eegbci.standardize
21+
fetch_aparc_sub_parcellation
22+
fetch_fsaverage
23+
fetch_hcp_mmp_parcellation
24+
fetch_infant_template
25+
fnirs_motor.data_path
26+
hf_sef.data_path
27+
kiloword.data_path
28+
limo.load_data
29+
misc.data_path
30+
mtrf.data_path
31+
multimodal.data_path
32+
opm.data_path
33+
sleep_physionet.age.fetch_data
34+
sleep_physionet.temazepam.fetch_data
35+
sample.data_path
36+
somato.data_path
37+
spm_face.data_path
38+
visual_92_categories.data_path
39+
phantom_4dbti.data_path
40+
refmeg_noise.data_path

‎doc/api/decoding.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
.. _api_decoding:
3+
4+
Decoding
5+
========
6+
7+
:py:mod:`mne.decoding`:
8+
9+
.. automodule:: mne.decoding
10+
:no-members:
11+
:no-inherited-members:
12+
13+
.. autosummary::
14+
:toctree: generated/
15+
16+
CSP
17+
EMS
18+
FilterEstimator
19+
LinearModel
20+
PSDEstimator
21+
Scaler
22+
TemporalFilter
23+
TimeFrequency
24+
UnsupervisedSpatialFilter
25+
Vectorizer
26+
ReceptiveField
27+
TimeDelayingRidge
28+
SlidingEstimator
29+
GeneralizingEstimator
30+
SPoC
31+
SSD
32+
33+
Functions that assist with decoding and model fitting:
34+
35+
.. autosummary::
36+
:toctree: generated/
37+
38+
compute_ems
39+
cross_val_multiscore
40+
get_coef

‎doc/api/events.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
2+
Events
3+
======
4+
5+
.. currentmodule:: mne
6+
7+
.. autosummary::
8+
:toctree: generated/
9+
10+
Annotations
11+
AcqParserFIF
12+
concatenate_events
13+
find_events
14+
find_stim_steps
15+
make_fixed_length_events
16+
make_fixed_length_epochs
17+
merge_events
18+
parse_config
19+
pick_events
20+
read_annotations
21+
read_events
22+
write_events
23+
concatenate_epochs
24+
events_from_annotations
25+
annotations_from_events
26+
27+
:py:mod:`mne.event`:
28+
29+
.. automodule:: mne.event
30+
:no-members:
31+
:no-inherited-members:
32+
33+
.. currentmodule:: mne.event
34+
35+
.. autosummary::
36+
:toctree: generated/
37+
38+
define_target_events
39+
shift_time_events
40+
41+
:py:mod:`mne.epochs`:
42+
43+
.. automodule:: mne.epochs
44+
:no-members:
45+
:no-inherited-members:
46+
47+
.. currentmodule:: mne.epochs
48+
49+
.. autosummary::
50+
:toctree: generated/
51+
52+
add_channels_epochs
53+
average_movements
54+
combine_event_ids
55+
equalize_epoch_counts

‎doc/api/file_io.rst

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
File I/O
2+
========
3+
4+
.. currentmodule:: mne
5+
6+
.. autosummary::
7+
:toctree: generated
8+
9+
channel_type
10+
channel_indices_by_type
11+
get_head_surf
12+
get_meg_helmet_surf
13+
get_volume_labels_from_aseg
14+
get_volume_labels_from_src
15+
parse_config
16+
read_labels_from_annot
17+
read_bem_solution
18+
read_bem_surfaces
19+
read_cov
20+
read_dipole
21+
read_epochs
22+
read_epochs_kit
23+
read_epochs_eeglab
24+
read_epochs_fieldtrip
25+
read_events
26+
read_evokeds
27+
read_evoked_fieldtrip
28+
read_evokeds_mff
29+
read_freesurfer_lut
30+
read_forward_solution
31+
read_label
32+
read_morph_map
33+
read_proj
34+
read_reject_parameters
35+
read_selection
36+
read_source_estimate
37+
read_source_spaces
38+
read_surface
39+
read_trans
40+
read_tri
41+
write_labels_to_annot
42+
write_bem_solution
43+
write_bem_surfaces
44+
write_cov
45+
write_events
46+
write_evokeds
47+
write_forward_solution
48+
write_label
49+
write_proj
50+
write_source_spaces
51+
write_surface
52+
write_trans
53+
what
54+
io.read_info
55+
io.show_fiff
56+
57+
Base class:
58+
59+
.. autosummary::
60+
:toctree: generated
61+
62+
BaseEpochs

‎doc/api/forward.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
2+
Forward Modeling
3+
================
4+
5+
.. currentmodule:: mne
6+
7+
.. autosummary::
8+
:toctree: generated/
9+
10+
Forward
11+
SourceSpaces
12+
add_source_space_distances
13+
apply_forward
14+
apply_forward_raw
15+
average_forward_solutions
16+
convert_forward_solution
17+
decimate_surface
18+
dig_mri_distances
19+
forward.compute_depth_prior
20+
forward.compute_orient_prior
21+
forward.restrict_forward_to_label
22+
forward.restrict_forward_to_stc
23+
make_bem_model
24+
make_bem_solution
25+
make_forward_dipole
26+
make_forward_solution
27+
make_field_map
28+
make_sphere_model
29+
morph_source_spaces
30+
read_bem_surfaces
31+
read_forward_solution
32+
read_trans
33+
read_source_spaces
34+
read_surface
35+
sensitivity_map
36+
setup_source_space
37+
setup_volume_source_space
38+
surface.complete_surface_info
39+
surface.read_curvature
40+
use_coil_def
41+
write_bem_surfaces
42+
write_trans
43+
44+
:py:mod:`mne.bem`:
45+
46+
.. automodule:: mne.bem
47+
:no-members:
48+
:no-inherited-members:
49+
50+
.. currentmodule:: mne.bem
51+
52+
.. autosummary::
53+
:toctree: generated/
54+
55+
ConductorModel
56+
fit_sphere_to_headshape
57+
get_fitting_dig
58+
make_watershed_bem
59+
make_flash_bem
60+
convert_flash_mris

0 commit comments

Comments
 (0)