doc updates [skip ci]

mne-tools · Jul 12, 2024 · 2897238 · 2897238
1 parent 048bfc3
commit 2897238
Show file tree

Hide file tree

Showing 78 changed files with 445 additions and 2,111 deletions.
diff --git a/dev/.buildinfo b/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: f304eda2a80f76f9f9a22b252adbfb46
+config: c2ef4344a071e605aefd65f27694da40
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/dev/_modules/index.html b/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.dev8+g313fe101 documentation</title>
+    <title>Overview: module code &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af documentation</p>
 
 </a></div>
 
@@ -564,7 +564,7 @@ <h1>All modules for which code is available</h1>
 
   <p class="copyright">
 
-      © Copyright 2017-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_bids/copyfiles.html b/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.dev8+g313fe101 documentation</title>
+    <title>mne_bids.copyfiles &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af 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-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_bids/dig.html b/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.dev8+g313fe101 documentation</title>
+    <title>mne_bids.dig &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af documentation</p>
 
 </a></div>
 
@@ -850,7 +850,7 @@ <h1>Source code for mne_bids.dig</h1><div class="highlight"><pre>
         <span class="n">hpi</span> <span class="o">=</span> <span class="p">{</span><span class="n">d</span><span class="p">[</span><span class="s2">&quot;ident&quot;</span><span class="p">]:</span> <span class="n">d</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">dig</span> <span class="k">if</span> <span class="n">d</span><span class="p">[</span><span class="s2">&quot;kind&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="n">FIFF</span><span class="o">.</span><span class="n">FIFFV_POINT_HPI</span><span class="p">}</span>
         <span class="k">if</span> <span class="n">hpi</span><span class="p">:</span>
             <span class="k">for</span> <span class="n">ident</span> <span class="ow">in</span> <span class="n">hpi</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
-                <span class="n">coords</span><span class="p">[</span><span class="s2">&quot;coil</span><span class="si">%d</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">ident</span><span class="p">]</span> <span class="o">=</span> <span class="n">hpi</span><span class="p">[</span><span class="n">ident</span><span class="p">][</span><span class="s2">&quot;r&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
+                <span class="n">coords</span><span class="p">[</span><span class="sa">f</span><span class="s2">&quot;coil</span><span class="si">{</span><span class="n">ident</span><span class="si">:</span><span class="s2">d</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">hpi</span><span class="p">[</span><span class="n">ident</span><span class="p">][</span><span class="s2">&quot;r&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
 
         <span class="n">fid_json</span> <span class="o">=</span> <span class="p">{</span>
             <span class="s2">&quot;MEGCoordinateSystem&quot;</span><span class="p">:</span> <span class="n">sensor_coord_system</span><span class="p">,</span>
@@ -1357,7 +1357,7 @@ <h1>Source code for mne_bids.dig</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_bids/inspect.html b/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.dev8+g313fe101 documentation</title>
+    <title>mne_bids.inspect &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af 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-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_bids/path.html b/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.dev8+g313fe101 documentation</title>
+    <title>mne_bids.path &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af documentation</p>
 
 </a></div>
 
@@ -3094,7 +3094,7 @@ <h1>Source code for mne_bids.path</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_bids/read.html b/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.dev8+g313fe101 documentation</title>
+    <title>mne_bids.read &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af 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-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_bids/report/_report.html b/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.dev8+g313fe101 documentation</title>
+    <title>mne_bids.report._report &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../../../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af 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-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_bids/sidecar_updates.html b/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.dev8+g313fe101 documentation</title>
+    <title>mne_bids.sidecar_updates &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af 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-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_bids/stats.html b/dev/_modules/mne_bids/stats.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.stats &#8212; MNE-BIDS 0.16.0.dev8+g313fe101 documentation</title>
+    <title>mne_bids.stats &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af documentation</p>
 
 </a></div>
 
@@ -689,7 +689,7 @@ <h1>Source code for mne_bids.stats</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_bids/utils.html b/dev/_modules/mne_bids/utils.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.utils &#8212; MNE-BIDS 0.16.0.dev8+g313fe101 documentation</title>
+    <title>mne_bids.utils &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af 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=fea48f8d"></script>
+    <script src="../../_static/documentation_options.js?v=fa8b614b"></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.dev8+g313fe101 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af documentation</p>
 
 </a></div>
 
@@ -1097,7 +1097,7 @@ <h1>Source code for mne_bids.utils</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2017-2024, MNE Developers. Last updated on 2024-07-11.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
       <br/>
 
   </p>