doc updates [skip ci]

dev/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 88be86eb1ead2c30bf7578c466dc42db
+config: 7e827f982bf71cd0f6a2c7d255480056
 tags: 645f666f9bcd5a90fca523b33c5a78b7

dev/_downloads/07841a9269d1816a3add41f32d8a5ed2/read_bids_datasets.ipynb

@@ -58,7 +58,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Explore the dataset contents\n\nWe can use MNE-BIDS to print a tree of all\nincluded files and folders. We pass the ``max_depth`` parameter to\n`mne_bids.print_dir_tree` to the output to four levels of folders, for\nbetter readability in this example.\n\n"
+        "## Explore the dataset contents\n\nWe can use MNE-BIDS to print a tree of all\nincluded files and folders. We pass the ``max_depth`` parameter to\n:func:`mne_bids.print_dir_tree` to the output to four levels of folders, for\nbetter readability in this example.\n\n"
       ]
     },
     {

dev/_downloads/0c7e85abda2fce1fe2c484ad9f9aaa81/bidspath.ipynb

@@ -112,7 +112,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Now that was easy! We're almost there! We also need to specify a\n**data type**, i.e., ``meg`` for MEG data, ``eeg`` and ``ieeg`` for EEG and\niEEG data, or ``anat`` for anatomical MRI scans. Typically, MNE-BIDS will\ninfer the data type of your data automatically, for example when writing data\nusing `mne_bids.write_raw_bids`. For the sake of this example, however, we\nare going to specify the data type explicitly.\n\n"
+        "Now that was easy! We're almost there! We also need to specify a\n**data type**, i.e., ``meg`` for MEG data, ``eeg`` and ``ieeg`` for EEG and\niEEG data, or ``anat`` for anatomical MRI scans. Typically, MNE-BIDS will\ninfer the data type of your data automatically, for example when writing data\nusing :func:`mne_bids.write_raw_bids`. For the sake of this example, however, we\nare going to specify the data type explicitly.\n\n"
       ]
     },
     {

dev/_downloads/4b11a3ce6cfd9d8cf2b976f8386a2f8f/bidspath.py

@@ -81,7 +81,7 @@
 # **data type**, i.e., ``meg`` for MEG data, ``eeg`` and ``ieeg`` for EEG and
 # iEEG data, or ``anat`` for anatomical MRI scans. Typically, MNE-BIDS will
 # infer the data type of your data automatically, for example when writing data
-# using `mne_bids.write_raw_bids`. For the sake of this example, however, we
+# using :func:`mne_bids.write_raw_bids`. For the sake of this example, however, we
 # are going to specify the data type explicitly.
 
 datatype = "eeg"

dev/_downloads/5eebd75ee4f8ffd30e34a83e87d0e28b/read_bids_datasets.py

@@ -78,7 +78,7 @@
 #
 # We can use MNE-BIDS to print a tree of all
 # included files and folders. We pass the ``max_depth`` parameter to
-# `mne_bids.print_dir_tree` to the output to four levels of folders, for
+# :func:`mne_bids.print_dir_tree` to the output to four levels of folders, for
 # better readability in this example.
 
 print_dir_tree(bids_root, max_depth=4)

dev/_downloads/6a10915cde9ea548655ec1feef4a85d1/update_bids_datasets.ipynb

@@ -58,7 +58,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Explore the dataset contents\n\nWe can use MNE-BIDS to print a tree of all\nincluded files and folders. We pass the ``max_depth`` parameter to\n`mne_bids.print_dir_tree` to the output to three levels of folders, for\nbetter readability in this example.\n\n"
+        "## Explore the dataset contents\n\nWe can use MNE-BIDS to print a tree of all\nincluded files and folders. We pass the ``max_depth`` parameter to\n:func:`mne_bids.print_dir_tree` to the output to three levels of folders, for\nbetter readability in this example.\n\n"
       ]
     },
     {

dev/_downloads/8a652dc37d1d38cf986f15eab46d0f7d/update_bids_datasets.py

@@ -48,7 +48,7 @@
 #
 # We can use MNE-BIDS to print a tree of all
 # included files and folders. We pass the ``max_depth`` parameter to
-# `mne_bids.print_dir_tree` to the output to three levels of folders, for
+# :func:`mne_bids.print_dir_tree` to the output to three levels of folders, for
 # better readability in this example.
 
 print_dir_tree(bids_root, max_depth=3)

dev/_modules/index.html

@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</title>
+    <title>Overview: module code &#8212; MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=551676d2"></script>
+    <script src="../_static/documentation_options.js?v=90a0f115"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</p>
 
 </a></div>
 
@@ -564,7 +564,7 @@ <h1>All modules for which code is available</h1>
 
   <p class="copyright">
 
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       <br/>
 
   </p>

dev/_modules/mne_bids/copyfiles.html

@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.copyfiles &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</title>
+    <title>mne_bids.copyfiles &#8212; MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=551676d2"></script>
+    <script src="../../_static/documentation_options.js?v=90a0f115"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</p>
 
 </a></div>
 
@@ -1211,7 +1211,7 @@ <h1>Source code for mne_bids.copyfiles</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       <br/>
 
   </p>

dev/_modules/mne_bids/dig.html

@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.dig &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</title>
+    <title>mne_bids.dig &#8212; MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=551676d2"></script>
+    <script src="../../_static/documentation_options.js?v=90a0f115"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</p>
 
 </a></div>
 
@@ -1357,7 +1357,7 @@ <h1>Source code for mne_bids.dig</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       <br/>
 
   </p>

dev/_modules/mne_bids/inspect.html

@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.inspect &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</title>
+    <title>mne_bids.inspect &#8212; MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=551676d2"></script>
+    <script src="../../_static/documentation_options.js?v=90a0f115"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</p>
 
 </a></div>
 
@@ -1012,7 +1012,7 @@ <h1>Source code for mne_bids.inspect</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       <br/>
 
   </p>

dev/_modules/mne_bids/path.html

@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.path &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</title>
+    <title>mne_bids.path &#8212; MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=551676d2"></script>
+    <script src="../../_static/documentation_options.js?v=90a0f115"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</p>
 
 </a></div>
 
@@ -1432,7 +1432,7 @@ <h1>Source code for mne_bids.path</h1><div class="highlight"><pre>
 <span class="sd">            If a boolean, controls whether to enforce BIDS conformity. This</span>
 <span class="sd">            will set the ``.check`` attribute accordingly. If ``None``, rely on</span>
 <span class="sd">            the existing ``.check`` attribute instead, which is set upon</span>
-<span class="sd">            `mne_bids.BIDSPath` instantiation. Defaults to ``None``.</span>
+<span class="sd">            :class:`mne_bids.BIDSPath` instantiation. Defaults to ``None``.</span>
 <span class="sd">        **kwargs : dict</span>
 <span class="sd">            It can contain updates for valid BIDSPath entities:</span>
 <span class="sd">            &#39;subject&#39;, &#39;session&#39;, &#39;task&#39;, &#39;acquisition&#39;, &#39;processing&#39;, &#39;run&#39;,</span>
@@ -1552,7 +1552,7 @@ <h1>Source code for mne_bids.path</h1><div class="highlight"><pre>
 <span class="sd">        check : bool</span>
 <span class="sd">            If ``True``, only returns paths that conform to BIDS. If ``False``</span>
 <span class="sd">            (default), the ``.check`` attribute of the returned</span>
-<span class="sd">            `mne_bids.BIDSPath` object will be set to ``True`` for paths that</span>
+<span class="sd">            :class:`mne_bids.BIDSPath` object will be set to ``True`` for paths that</span>
 <span class="sd">            do conform to BIDS, and to ``False`` for those that don&#39;t.</span>
 
 <span class="sd">        Returns</span>
@@ -2947,7 +2947,7 @@ <h1>Source code for mne_bids.path</h1><div class="highlight"><pre>
 <span class="sd">    check : bool</span>
 <span class="sd">        If ``True``, only returns paths that conform to BIDS. If ``False``</span>
 <span class="sd">        (default), the ``.check`` attribute of the returned</span>
-<span class="sd">        `mne_bids.BIDSPath` object will be set to ``True`` for paths that</span>
+<span class="sd">        :class:`mne_bids.BIDSPath` object will be set to ``True`` for paths that</span>
 <span class="sd">        do conform to BIDS, and to ``False`` for those that don&#39;t.</span>
 
 <span class="sd">    Returns</span>
@@ -3025,7 +3025,7 @@ <h1>Source code for mne_bids.path</h1><div class="highlight"><pre>
 <span class="sd">    check : bool</span>
 <span class="sd">        If ``True``, only returns paths that conform to BIDS. If ``False``</span>
 <span class="sd">        (default), the ``.check`` attribute of the returned</span>
-<span class="sd">        `mne_bids.BIDSPath` object will be set to ``True`` for paths that</span>
+<span class="sd">        :class:`mne_bids.BIDSPath` object will be set to ``True`` for paths that</span>
 <span class="sd">        do conform to BIDS, and to ``False`` for those that don&#39;t.</span>
 
 <span class="sd">    Returns</span>
@@ -3094,7 +3094,7 @@ <h1>Source code for mne_bids.path</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       <br/>
 
   </p>

dev/_modules/mne_bids/read.html

@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.read &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</title>
+    <title>mne_bids.read &#8212; MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=551676d2"></script>
+    <script src="../../_static/documentation_options.js?v=90a0f115"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</p>
 
 </a></div>
 
@@ -1742,7 +1742,7 @@ <h1>Source code for mne_bids.read</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       <br/>
 
   </p>

dev/_modules/mne_bids/report/_report.html

@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.report._report &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</title>
+    <title>mne_bids.report._report &#8212; MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../../_static/documentation_options.js?v=551676d2"></script>
+    <script src="../../../_static/documentation_options.js?v=90a0f115"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</p>
 
 </a></div>
 
@@ -1098,7 +1098,7 @@ <h1>Source code for mne_bids.report._report</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       <br/>
 
   </p>

dev/_modules/mne_bids/sidecar_updates.html

@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.sidecar_updates &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</title>
+    <title>mne_bids.sidecar_updates &#8212; MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=551676d2"></script>
+    <script src="../../_static/documentation_options.js?v=90a0f115"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation</p>
 
 </a></div>
 
@@ -949,7 +949,7 @@ <h1>Source code for mne_bids.sidecar_updates</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       <br/>
 
   </p>