doc updates [skip ci]

mne-tools · Jul 12, 2024 · 06b5bf3 · 06b5bf3
1 parent 2dcacf1
commit 06b5bf3
Show file tree

Hide file tree

Showing 78 changed files with 332 additions and 331 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: e6bcad15472edbff205161d3a33127f4
+config: 88be86eb1ead2c30bf7578c466dc42db
 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.dev10+g4c3e7535 documentation</title>
+    <title>Overview: module code &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 

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.dev10+g4c3e7535 documentation</title>
+    <title>mne_bids.copyfiles &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 

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.dev10+g4c3e7535 documentation</title>
+    <title>mne_bids.dig &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 

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.dev10+g4c3e7535 documentation</title>
+    <title>mne_bids.inspect &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 

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.dev10+g4c3e7535 documentation</title>
+    <title>mne_bids.path &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 

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.dev10+g4c3e7535 documentation</title>
+    <title>mne_bids.read &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 

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.dev10+g4c3e7535 documentation</title>
+    <title>mne_bids.report._report &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../../../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 

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.dev10+g4c3e7535 documentation</title>
+    <title>mne_bids.sidecar_updates &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 
@@ -748,7 +748,7 @@ <h1>Source code for mne_bids.sidecar_updates</h1><div class="highlight"><pre>
 
     <span class="k">if</span> <span class="n">bids_path_mri</span><span class="o">.</span><span class="n">suffix</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
-            <span class="s1">&#39;Please specify the &quot;suffix&quot; entity of the provided &#39;</span> <span class="s2">&quot;bids_path.&quot;</span>
+            <span class="s1">&#39;Please specify the &quot;suffix&quot; entity of the provided bids_path.&#39;</span>
         <span class="p">)</span>
     <span class="k">elif</span> <span class="n">bids_path_mri</span><span class="o">.</span><span class="n">suffix</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">&quot;T1w&quot;</span><span class="p">,</span> <span class="s2">&quot;FLASH&quot;</span><span class="p">):</span>
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>

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.dev10+g4c3e7535 documentation</title>
+    <title>mne_bids.stats &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 

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.dev10+g4c3e7535 documentation</title>
+    <title>mne_bids.utils &#8212; MNE-BIDS 0.16.0.dev11+gdbdf957f 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=a6fa244f"></script>
+    <script src="../../_static/documentation_options.js?v=551676d2"></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.dev10+g4c3e7535 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev11+gdbdf957f documentation</p>
 
 </a></div>
 
@@ -740,7 +740,7 @@ <h1>Source code for mne_bids.utils</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Write JSON to a file.&quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">op</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">overwrite</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">FileExistsError</span><span class="p">(</span>
-            <span class="sa">f</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">fname</span><span class="si">}</span><span class="s1">&quot; already exists. &#39;</span> <span class="s2">&quot;Please set overwrite to True.&quot;</span>
+            <span class="sa">f</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">fname</span><span class="si">}</span><span class="s1">&quot; already exists. Please set overwrite to True.&#39;</span>
         <span class="p">)</span>
 
     <span class="n">json_output</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">dictionary</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
@@ -756,7 +756,7 @@ <h1>Source code for mne_bids.utils</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Write an ordered dictionary to a .tsv file.&quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">op</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">overwrite</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">FileExistsError</span><span class="p">(</span>
-            <span class="sa">f</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">fname</span><span class="si">}</span><span class="s1">&quot; already exists. &#39;</span> <span class="s2">&quot;Please set overwrite to True.&quot;</span>
+            <span class="sa">f</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">fname</span><span class="si">}</span><span class="s1">&quot; already exists. Please set overwrite to True.&#39;</span>
         <span class="p">)</span>
     <span class="n">_to_tsv</span><span class="p">(</span><span class="n">dictionary</span><span class="p">,</span> <span class="n">fname</span><span class="p">)</span>
 
@@ -767,7 +767,7 @@ <h1>Source code for mne_bids.utils</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Write text to a file.&quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">op</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">overwrite</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">FileExistsError</span><span class="p">(</span>
-            <span class="sa">f</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">fname</span><span class="si">}</span><span class="s1">&quot; already exists. &#39;</span> <span class="s2">&quot;Please set overwrite to True.&quot;</span>
+            <span class="sa">f</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">fname</span><span class="si">}</span><span class="s1">&quot; already exists. Please set overwrite to True.&#39;</span>
         <span class="p">)</span>
     <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">fname</span><span class="p">,</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">&quot;utf-8-sig&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fid</span><span class="p">:</span>
         <span class="n">fid</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>