doc updates [skip ci]

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

Hide file tree

Showing 78 changed files with 342 additions and 340 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: c2ef4344a071e605aefd65f27694da40
+config: e6bcad15472edbff205161d3a33127f4
 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.dev9+gf4f903af documentation</title>
+    <title>Overview: module code &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 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=fa8b614b"></script>
+    <script src="../_static/documentation_options.js?v=a6fa244f"></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.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 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.dev9+gf4f903af documentation</title>
+    <title>mne_bids.copyfiles &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 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=fa8b614b"></script>
+    <script src="../../_static/documentation_options.js?v=a6fa244f"></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.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 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.dev9+gf4f903af documentation</title>
+    <title>mne_bids.dig &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 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=fa8b614b"></script>
+    <script src="../../_static/documentation_options.js?v=a6fa244f"></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.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 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.dev9+gf4f903af documentation</title>
+    <title>mne_bids.inspect &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 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=fa8b614b"></script>
+    <script src="../../_static/documentation_options.js?v=a6fa244f"></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.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 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.dev9+gf4f903af documentation</title>
+    <title>mne_bids.path &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 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=fa8b614b"></script>
+    <script src="../../_static/documentation_options.js?v=a6fa244f"></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.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 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.dev9+gf4f903af documentation</title>
+    <title>mne_bids.read &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 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=fa8b614b"></script>
+    <script src="../../_static/documentation_options.js?v=a6fa244f"></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.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 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.dev9+gf4f903af documentation</title>
+    <title>mne_bids.report._report &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 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=fa8b614b"></script>
+    <script src="../../../_static/documentation_options.js?v=a6fa244f"></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.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 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.dev9+gf4f903af documentation</title>
+    <title>mne_bids.sidecar_updates &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 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=fa8b614b"></script>
+    <script src="../../_static/documentation_options.js?v=a6fa244f"></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.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 documentation</p>
 
 </a></div>
 

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

diff --git a/dev/_modules/mne_bids/write.html b/dev/_modules/mne_bids/write.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.write &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af documentation</title>
+    <title>mne_bids.write &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 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=fa8b614b"></script>
+    <script src="../../_static/documentation_options.js?v=a6fa244f"></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.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 documentation</p>
 
 </a></div>
 
@@ -2337,7 +2337,7 @@ <h1>Source code for mne_bids.write</h1><div class="highlight"><pre>
         <span class="n">er_bids_path</span> <span class="o">=</span> <span class="n">bids_path</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
             <span class="n">subject</span><span class="o">=</span><span class="s2">&quot;emptyroom&quot;</span><span class="p">,</span> <span class="n">session</span><span class="o">=</span><span class="n">er_session</span><span class="p">,</span> <span class="n">task</span><span class="o">=</span><span class="s2">&quot;noise&quot;</span><span class="p">,</span> <span class="n">run</span><span class="o">=</span><span class="kc">None</span>
         <span class="p">)</span>
-        <span class="n">write_raw_bids</span><span class="p">(</span>
+        <span class="n">er_bids_path</span> <span class="o">=</span> <span class="n">write_raw_bids</span><span class="p">(</span>
             <span class="n">raw</span><span class="o">=</span><span class="n">empty_room</span><span class="p">,</span>
             <span class="n">bids_path</span><span class="o">=</span><span class="n">er_bids_path</span><span class="p">,</span>
             <span class="n">events</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>

diff --git a/dev/_static/documentation_options.js b/dev/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.16.0.dev9+gf4f903af',
+    VERSION: '0.16.0.dev10+g4c3e7535',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/dev/api.html b/dev/api.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>API Documentation &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af documentation</title>
+    <title>API Documentation &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 documentation</title>
 
 
 
@@ -41,7 +41,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=fa8b614b"></script>
+    <script src="_static/documentation_options.js?v=a6fa244f"></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>
@@ -150,7 +150,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 documentation</p>
 
 </a></div>
 

diff --git a/dev/authors.html b/dev/authors.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>&lt;no title&gt; &#8212; MNE-BIDS 0.16.0.dev9+gf4f903af documentation</title>
+    <title>&lt;no title&gt; &#8212; MNE-BIDS 0.16.0.dev10+g4c3e7535 documentation</title>
 
 
 
@@ -41,7 +41,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=fa8b614b"></script>
+    <script src="_static/documentation_options.js?v=a6fa244f"></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>
@@ -148,7 +148,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev9+gf4f903af documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev10+g4c3e7535 documentation</p>
 
 </a></div>