doc updates [skip ci]

mne-tools · Feb 29, 2024 · 62cffa9 · 62cffa9
1 parent 9e75439
commit 62cffa9
Show file tree

Hide file tree

Showing 78 changed files with 1,861 additions and 417 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: 51e5500105fe520fa87a1bed9a71bb36
+config: 60cd31aa8d508b4a36680d2890e631fa
 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.15.0.dev35+ge41b5173 documentation</title>
+    <title>Overview: module code &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -568,7 +568,7 @@ <h1>All modules for which code is available</h1>
 
   <p class="copyright">
 
-      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <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.15.0.dev35+ge41b5173 documentation</title>
+    <title>mne_bids.copyfiles &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -684,6 +684,13 @@ <h1>Source code for mne_bids.copyfiles</h1><div class="highlight"><pre>
         <span class="s2">&quot;.newds&quot;</span><span class="p">,</span>
         <span class="s2">&quot;.res4&quot;</span><span class="p">,</span>
     <span class="p">)</span>
+
+    <span class="c1"># Consider CTF files that are split having consecutively numbered extensions</span>
+    <span class="n">extra_ctf_file_types</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span>
+        <span class="sa">f</span><span class="s2">&quot;.</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">_meg4&quot;</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">21</span><span class="p">)</span>
+    <span class="p">)</span>  <span class="c1"># cap at 20 is arbitrary</span>
+    <span class="n">file_types</span> <span class="o">+=</span> <span class="n">extra_ctf_file_types</span>
+
     <span class="c1"># Rename files in dest with the name of the dest directory</span>
     <span class="n">fnames</span> <span class="o">=</span> <span class="p">[</span><span class="n">f</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dest</span><span class="p">)</span> <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">file_types</span><span class="p">)]</span>
     <span class="n">bids_folder_name</span> <span class="o">=</span> <span class="n">op</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">op</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">dest</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span>
@@ -1213,7 +1220,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-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <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.15.0.dev35+ge41b5173 documentation</title>
+    <title>mne_bids.dig &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -1362,7 +1362,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-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <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.15.0.dev35+ge41b5173 documentation</title>
+    <title>mne_bids.inspect &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -1017,7 +1017,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-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <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.15.0.dev35+ge41b5173 documentation</title>
+    <title>mne_bids.path &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -3098,7 +3098,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-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <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.15.0.dev35+ge41b5173 documentation</title>
+    <title>mne_bids.read &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -1720,7 +1720,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-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <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.15.0.dev35+ge41b5173 documentation</title>
+    <title>mne_bids.report._report &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../../../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -1101,7 +1101,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-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <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.15.0.dev35+ge41b5173 documentation</title>
+    <title>mne_bids.sidecar_updates &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -956,7 +956,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-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <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.15.0.dev35+ge41b5173 documentation</title>
+    <title>mne_bids.stats &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -695,7 +695,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-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <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.15.0.dev35+ge41b5173 documentation</title>
+    <title>mne_bids.utils &#8212; MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../_static/documentation_options.js?v=cf31b2a3"></script>
+    <script src="../../_static/documentation_options.js?v=5dd60dc4"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev35+ge41b5173 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev36+g28e8cdb3 documentation</p>
 
 </a></div>
 
@@ -1105,7 +1105,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-02-22.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-02-29.
       <br/>
 
   </p>