Skip to content

Commit feb0bec

Browse files
authored
MRG: More doc cleanups (#5813)
* FIX: More doc cleanups * FIX: No source
1 parent fd2e3d2 commit feb0bec

File tree

12 files changed

+44
-165
lines changed

12 files changed

+44
-165
lines changed
File renamed without changes.
File renamed without changes.

doc/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@
126126

127127
# The reST default role (used for this markup: `text`) to use for all
128128
# documents.
129-
#default_role = None
129+
default_role = "autolink"
130130

131131
# If true, '()' will be appended to :func: etc. cross-reference text.
132132
#add_function_parentheses = True
@@ -231,6 +231,7 @@
231231

232232
# If true, links to the reST sources are added to the pages.
233233
html_show_sourcelink = False
234+
html_copy_source = False
234235

235236
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
236237
html_show_sphinx = False

doc/glossary.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,17 @@ MNE-Python core terminology and general concepts
5959
stim channel.
6060

6161
first_samp
62-
The attribute of raw objects called `first_samp` is an integer that
62+
The attribute of raw objects called ``first_samp`` is an integer that
6363
refers to the number of time samples passed between the onset of the
6464
acquisition system and the time when data started to be written
6565
on disk. This is a specificity of the Vectorview MEG systems (fif files)
6666
but for consistency it is available for all file formats in MNE.
6767
One benefit of this system is that croppping data only boils
68-
down to a change of the `first_samp` attribute to know when cropped data
68+
down to a change of the ``first_samp`` attribute to know when cropped data
6969
was acquired.
7070

7171
info
72-
Also called `measurements info`, it is a collection of metadata regarding
72+
Also called ``measurement info``, it is a collection of metadata regarding
7373
a Raw, Epochs or Evoked object; e.g.,
7474
channel locations and types, sampling frequency,
7575
preprocessing history such as filters ...
@@ -82,7 +82,7 @@ MNE-Python core terminology and general concepts
8282

8383
montage
8484
EEG channel names and the relative positions of the sensor w.r.t. the scalp.
85-
See :class:`Montage <channels.Montage>` for the API of the corresponding object
85+
See :class:`~channels.Montage` for the API of the corresponding object
8686
class.
8787

8888
morphing
@@ -94,26 +94,26 @@ MNE-Python core terminology and general concepts
9494
pick
9595
An integer that is the index of a channel in the measurement info.
9696
It allows to obtain the information on a channel in the list of channels
97-
available in `info['chs']`.
97+
available in ``info['chs']``.
9898

99-
projector, (abbr. `proj`)
99+
projector, (abbr. ``proj``)
100100
A projector, also referred to a Signal Suspace Projection (SSP), defines
101101
a linear operation applied spatially to EEG or MEG data. You can see
102102
this as a matrix multiplication that reduces the rank of the data by
103103
projecting it to a lower dimensional subspace. Such a projection
104104
operator is applied to both the data and the forward operator for
105105
source localization. Note that EEG average referencing can be done
106106
using such a projection operator. It is stored in the measurement
107-
info in `info['projs']`.
107+
info in ``info['projs']``.
108108

109109
raw
110110
It corresponds to continuous data (preprocessed or not). One typically
111111
manipulates raw data when reading recordings in a file on disk.
112-
See :class:`RawArray <io.RawArray>` for the API of the corresponding
112+
See :class:`~io.RawArray` for the API of the corresponding
113113
object class, and :ref:`sphx_glr_auto_tutorials_plot_object_raw.py` for a
114114
narrative overview.
115115

116-
source space (abbr. `src`)
116+
source space (abbr. ``src``)
117117
A source space specifies where in the brain one wants to estimate the
118118
source amplitudes. It corresponds to locations of a set of
119119
candidate equivalent current dipoles (ECD). MNE mostly works
@@ -124,7 +124,7 @@ MNE-Python core terminology and general concepts
124124
See :class:`SourceSpaces` for the API of the corresponding
125125
object class.
126126

127-
source estimates (abbr. `stc`)
127+
source estimates (abbr. ``stc``)
128128
Source estimates, commonly referred to as STC (Source Time Courses),
129129
are obtained from source localization methods,
130130
such as dSPM, sLORETA, LCMV or MxNE.
@@ -144,7 +144,7 @@ MNE-Python core terminology and general concepts
144144
A stim channel, a.k.a. trigger channel, is a channel that encodes events
145145
during the recording. It is typically a channel that is always zero and that
146146
takes positive values when something happens such as the onset of a stimulus.
147-
Classical names for stim channels is `STI 014` or `STI 101`.
147+
Classical names for stim channels is ``STI 014`` or ``STI 101``.
148148
So-called events arrays are obtained from stim channels.
149149

150150
trans

0 commit comments

Comments
 (0)