From 8eed05e506d3816cac27eedcfbe37eb87e00d03b Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 15 May 2025 12:34:16 +0200 Subject: [PATCH] DOC: link to background info on fsaverage --- doc/documentation/datasets.rst | 3 ++- mne/datasets/_fsaverage/base.py | 2 +- tutorials/forward/10_background_freesurfer.py | 2 ++ tutorials/forward/35_eeg_no_mri.py | 2 +- 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/documentation/datasets.rst b/doc/documentation/datasets.rst index 0a0280ae5ac..2ec98664e74 100644 --- a/doc/documentation/datasets.rst +++ b/doc/documentation/datasets.rst @@ -398,7 +398,8 @@ fsaverage :func:`mne.datasets.fetch_fsaverage` For convenience, we provide a function to separately download and extract the -(or update an existing) fsaverage subject. +(or update an existing) fsaverage subject. See also the +:ref:`background information on fsaverage `. .. topic:: Examples diff --git a/mne/datasets/_fsaverage/base.py b/mne/datasets/_fsaverage/base.py index b15a8c7a94c..58b136bfd23 100644 --- a/mne/datasets/_fsaverage/base.py +++ b/mne/datasets/_fsaverage/base.py @@ -12,7 +12,7 @@ @verbose def fetch_fsaverage(subjects_dir=None, *, verbose=None): - """Fetch and update fsaverage. + """Fetch and update :ref:`fsaverage `. Parameters ---------- diff --git a/tutorials/forward/10_background_freesurfer.py b/tutorials/forward/10_background_freesurfer.py index 4975a191d7b..80ffe009b3b 100644 --- a/tutorials/forward/10_background_freesurfer.py +++ b/tutorials/forward/10_background_freesurfer.py @@ -118,6 +118,8 @@ # MNE-Python and FreeSurfer are integrated. # # +# .. _fsaverage_background: +# # 'fsaverage' # =========== # diff --git a/tutorials/forward/35_eeg_no_mri.py b/tutorials/forward/35_eeg_no_mri.py index 12ea2ac2913..9324898ccf5 100644 --- a/tutorials/forward/35_eeg_no_mri.py +++ b/tutorials/forward/35_eeg_no_mri.py @@ -6,7 +6,7 @@ ======================================== This tutorial explains how to compute the forward operator from EEG data -using the standard template MRI subject ``fsaverage``. +using the standard template MRI subject :ref:`fsaverage `. .. caution:: Source reconstruction without an individual T1 MRI from the subject will be less accurate. Do not over interpret activity