doc updates [skip ci]

mne-tools · May 13, 2024 · 0582cc7 · 0582cc7
1 parent 24cd771
commit 0582cc7
Show file tree

Hide file tree

Showing 97 changed files with 870 additions and 824 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: b99b9e91967331f74aa186cab3c9ba80
+config: 273920a69f57f5c5a1ae6fcc66d48802
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/dev/_downloads/07841a9269d1816a3add41f32d8a5ed2/read_bids_datasets.ipynb b/dev/_downloads/07841a9269d1816a3add41f32d8a5ed2/read_bids_datasets.ipynb
@@ -337,7 +337,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/dev/_downloads/0bc5481d861907f3ba86dd37d953b980/convert_eeg_to_bids.ipynb b/dev/_downloads/0bc5481d861907f3ba86dd37d953b980/convert_eeg_to_bids.ipynb
@@ -283,7 +283,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/0c7e85abda2fce1fe2c484ad9f9aaa81/bidspath.ipynb b/dev/_downloads/0c7e85abda2fce1fe2c484ad9f9aaa81/bidspath.ipynb
@@ -312,7 +312,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/241c30601b8e062b34a8b85829a39a45/convert_group_studies.ipynb b/dev/_downloads/241c30601b8e062b34a8b85829a39a45/convert_group_studies.ipynb
@@ -179,7 +179,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/529f3230e5683b7676557bd33b2ea01b/convert_mne_sample.ipynb b/dev/_downloads/529f3230e5683b7676557bd33b2ea01b/convert_mne_sample.ipynb
@@ -294,7 +294,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/58cece9c8037ffebaaad2703d5ce7839/convert_empty_room.ipynb b/dev/_downloads/58cece9c8037ffebaaad2703d5ce7839/convert_empty_room.ipynb
@@ -233,7 +233,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/6a10915cde9ea548655ec1feef4a85d1/update_bids_datasets.ipynb b/dev/_downloads/6a10915cde9ea548655ec1feef4a85d1/update_bids_datasets.ipynb
@@ -186,7 +186,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/6a8efa177441ca0b84ef1b16e3806949/anonymize_dataset.ipynb b/dev/_downloads/6a8efa177441ca0b84ef1b16e3806949/anonymize_dataset.ipynb
@@ -183,7 +183,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/dev/_downloads/9160181635ad137cb4a8a5779295596c/convert_mri_and_trans.ipynb b/dev/_downloads/9160181635ad137cb4a8a5779295596c/convert_mri_and_trans.ipynb
@@ -294,7 +294,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/9cf968a426e81cc54e7ebab7dc9ef899/create_bids_folder.ipynb b/dev/_downloads/9cf968a426e81cc54e7ebab7dc9ef899/create_bids_folder.ipynb
@@ -107,7 +107,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/b666106ea850b55fb6bc69db6fdda679/convert_nirs_to_bids.ipynb b/dev/_downloads/b666106ea850b55fb6bc69db6fdda679/convert_nirs_to_bids.ipynb
@@ -258,7 +258,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/bcdfe0d0e220cf6da56beb8f9163c326/mark_bad_channels.ipynb b/dev/_downloads/bcdfe0d0e220cf6da56beb8f9163c326/mark_bad_channels.ipynb
@@ -215,7 +215,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/cf640e6bfa39f55978e620ef4269fd4c/convert_ieeg_to_bids.ipynb b/dev/_downloads/cf640e6bfa39f55978e620ef4269fd4c/convert_ieeg_to_bids.ipynb
@@ -391,7 +391,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/fecfce9ee6664349717e6262ae61875d/rename_brainvision_files.ipynb b/dev/_downloads/fecfce9ee6664349717e6262ae61875d/rename_brainvision_files.ipynb
@@ -96,7 +96,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.12.1"
+      "version": "3.12.2"
     }
   },
   "nbformat": 4,

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.dev48+ge8eb7a7f documentation</title>
+    <title>Overview: module code &#8212; MNE-BIDS 0.15.0.dev49+g96f8deed documentation</title>
 
 
 
@@ -40,8 +40,8 @@
 <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=8d36bba7"></script>
-    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/documentation_options.js?v=90d4fd1f"></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>
     <script src="../_static/copybutton.js?v=fd10adb8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev48+ge8eb7a7f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev49+g96f8deed 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-04-09.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-05-13.
       <br/>
 
   </p>
@@ -577,7 +577,7 @@ <h1>All modules for which code is available</h1>
         <div class="footer-item">
 
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     <br/>
   </p>
 </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.15.0.dev48+ge8eb7a7f documentation</title>
+    <title>mne_bids.copyfiles &#8212; MNE-BIDS 0.15.0.dev49+g96f8deed documentation</title>
 
 
 
@@ -40,8 +40,8 @@
 <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=8d36bba7"></script>
-    <script src="../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../_static/documentation_options.js?v=90d4fd1f"></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>
     <script src="../../_static/copybutton.js?v=fd10adb8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev48+ge8eb7a7f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev49+g96f8deed documentation</p>
 
 </a></div>
 
@@ -1221,7 +1221,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-04-09.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-05-13.
       <br/>
 
   </p>
@@ -1230,7 +1230,7 @@ <h1>Source code for mne_bids.copyfiles</h1><div class="highlight"><pre>
         <div class="footer-item">
 
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     <br/>
   </p>
 </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.15.0.dev48+ge8eb7a7f documentation</title>
+    <title>mne_bids.dig &#8212; MNE-BIDS 0.15.0.dev49+g96f8deed documentation</title>
 
 
 
@@ -40,8 +40,8 @@
 <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=8d36bba7"></script>
-    <script src="../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../_static/documentation_options.js?v=90d4fd1f"></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>
     <script src="../../_static/copybutton.js?v=fd10adb8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev48+ge8eb7a7f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev49+g96f8deed documentation</p>
 
 </a></div>
 
@@ -1363,7 +1363,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-04-09.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-05-13.
       <br/>
 
   </p>
@@ -1372,7 +1372,7 @@ <h1>Source code for mne_bids.dig</h1><div class="highlight"><pre>
         <div class="footer-item">
 
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     <br/>
   </p>
 </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.15.0.dev48+ge8eb7a7f documentation</title>
+    <title>mne_bids.inspect &#8212; MNE-BIDS 0.15.0.dev49+g96f8deed documentation</title>
 
 
 
@@ -40,8 +40,8 @@
 <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=8d36bba7"></script>
-    <script src="../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../_static/documentation_options.js?v=90d4fd1f"></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>
     <script src="../../_static/copybutton.js?v=fd10adb8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev48+ge8eb7a7f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev49+g96f8deed 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-04-09.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-05-13.
       <br/>
 
   </p>
@@ -1026,7 +1026,7 @@ <h1>Source code for mne_bids.inspect</h1><div class="highlight"><pre>
         <div class="footer-item">
 
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     <br/>
   </p>
 </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.15.0.dev48+ge8eb7a7f documentation</title>
+    <title>mne_bids.path &#8212; MNE-BIDS 0.15.0.dev49+g96f8deed documentation</title>
 
 
 
@@ -40,8 +40,8 @@
 <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=8d36bba7"></script>
-    <script src="../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../_static/documentation_options.js?v=90d4fd1f"></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>
     <script src="../../_static/copybutton.js?v=fd10adb8"></script>
@@ -144,7 +144,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.15.0.dev48+ge8eb7a7f documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.15.0.dev49+g96f8deed documentation</p>
 
 </a></div>
 
@@ -3099,7 +3099,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-04-09.
+      © Copyright 2017-2024, MNE Developers. Last updated on 2024-05-13.
       <br/>
 
   </p>
@@ -3108,7 +3108,7 @@ <h1>Source code for mne_bids.path</h1><div class="highlight"><pre>
         <div class="footer-item">
 
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     <br/>
   </p>
 </div>