doc updates [skip ci] (1151)

mne-tools · Jul 15, 2024 · 7aaffc6 · 7aaffc6
1 parent 2f54c1a
commit 7aaffc6
Show file tree

Hide file tree

Showing 104 changed files with 692 additions and 1,057 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: f9fc0bad380d6de1426114b1cdaddbeb
+config: e8bf2ee5afcbc39766a9777acf44efdc
 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/0e2cac543ebccdb0eddca96bb909d43a/cacoh.zip b/dev/_downloads/0e2cac543ebccdb0eddca96bb909d43a/cacoh.zip
diff --git a/dev/_downloads/0fe046d410690dd02441adbdb94740c0/mixed_source_space_connectivity.zip b/dev/_downloads/0fe046d410690dd02441adbdb94740c0/mixed_source_space_connectivity.zip
diff --git a/dev/_downloads/15d5720b7c9da8789e8399a45f5feac9/mne_inverse_envelope_correlation.zip b/dev/_downloads/15d5720b7c9da8789e8399a45f5feac9/mne_inverse_envelope_correlation.zip
diff --git a/dev/_downloads/1de2d9313328ac7a0580e229b8a5cbbc/mne_inverse_label_connectivity.zip b/dev/_downloads/1de2d9313328ac7a0580e229b8a5cbbc/mne_inverse_label_connectivity.zip
diff --git a/dev/_downloads/1f1893579bb597251e98a3bde46e316f/granger_causality.zip b/dev/_downloads/1f1893579bb597251e98a3bde46e316f/granger_causality.zip
diff --git a/dev/_downloads/348ea9dd9d83b9841ec181fcf6820999/cohy_decomposition_plotting.zip b/dev/_downloads/348ea9dd9d83b9841ec181fcf6820999/cohy_decomposition_plotting.zip
diff --git a/dev/_downloads/5a7e4b04d139bf223ad6c4a43af76dcd/cohy_decomposition.zip b/dev/_downloads/5a7e4b04d139bf223ad6c4a43af76dcd/cohy_decomposition.zip
diff --git a/..._downloads/5b4c04b6c84ce2fd08b907a8b5d0e7d1/compare_connectivity_over_time_over_trial.zip b/..._downloads/5b4c04b6c84ce2fd08b907a8b5d0e7d1/compare_connectivity_over_time_over_trial.zip
diff --git a/dev/_downloads/5d710507a772f60c05c894f77a15f158/connectivity_classes.zip b/dev/_downloads/5d710507a772f60c05c894f77a15f158/connectivity_classes.zip
diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/dev/_downloads/71147ba97f82e69ff8b49d0342b9a589/mne_inverse_coherence_epochs.zip b/dev/_downloads/71147ba97f82e69ff8b49d0342b9a589/mne_inverse_coherence_epochs.zip
diff --git a/dev/_downloads/83598d1d801de7e37ea5fe0a19e0a4fc/cwt_sensor_connectivity.zip b/dev/_downloads/83598d1d801de7e37ea5fe0a19e0a4fc/cwt_sensor_connectivity.zip
diff --git a/dev/_downloads/8cb2e6ba3da421678a517077a9590a3c/mne_var_connectivity.zip b/dev/_downloads/8cb2e6ba3da421678a517077a9590a3c/mne_var_connectivity.zip
diff --git a/dev/_downloads/8f8ea11e72191775746dd7cc0d761e6a/mne_inverse_psi_visual.zip b/dev/_downloads/8f8ea11e72191775746dd7cc0d761e6a/mne_inverse_psi_visual.zip
diff --git a/dev/_downloads/947727abe2944e1337e111fe1a47dcde/sensor_connectivity.zip b/dev/_downloads/947727abe2944e1337e111fe1a47dcde/sensor_connectivity.zip
diff --git a/dev/_downloads/9bb5cf4c4ac8dd134e16d5b90ca7c4fe/mne_inverse_connectivity_spectrum.zip b/dev/_downloads/9bb5cf4c4ac8dd134e16d5b90ca7c4fe/mne_inverse_connectivity_spectrum.zip
diff --git a/dev/_downloads/a2f678085d65b181d85eef728e9f4aa7/mic_mim.zip b/dev/_downloads/a2f678085d65b181d85eef728e9f4aa7/mic_mim.zip
diff --git a/dev/_downloads/a6553535315fe003837975c763e28ecf/compare_coherency_methods.zip b/dev/_downloads/a6553535315fe003837975c763e28ecf/compare_coherency_methods.zip
diff --git a/dev/_downloads/b5626e9a9c504cb943b32de3dd6197c9/dpli_wpli_pli.zip b/dev/_downloads/b5626e9a9c504cb943b32de3dd6197c9/dpli_wpli_pli.zip
diff --git a/dev/_downloads/c8df8b748262c4852e771fae4c665b59/mne_inverse_envelope_correlation_volume.zip b/dev/_downloads/c8df8b748262c4852e771fae4c665b59/mne_inverse_envelope_correlation_volume.zip
diff --git a/dev/_downloads/d7f2c5fcd3f646e25c5a522067368f75/handling_ragged_arrays.zip b/dev/_downloads/d7f2c5fcd3f646e25c5a522067368f75/handling_ragged_arrays.zip
diff --git a/dev/_images/sphx_glr_dpli_wpli_pli_001.png b/dev/_images/sphx_glr_dpli_wpli_pli_001.png
diff --git a/dev/_images/sphx_glr_dpli_wpli_pli_002.png b/dev/_images/sphx_glr_dpli_wpli_pli_002.png
diff --git a/dev/_images/sphx_glr_dpli_wpli_pli_004.png b/dev/_images/sphx_glr_dpli_wpli_pli_004.png
diff --git a/dev/_images/sphx_glr_dpli_wpli_pli_thumb.png b/dev/_images/sphx_glr_dpli_wpli_pli_thumb.png
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-Connectivity 1.8.0.dev96+g1a341b1ba documentation</title>
+    <title>Overview: module code &#8212; MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
 
-    <script src="../_static/documentation_options.js?v=0f1ab173"></script>
+    <script src="../_static/documentation_options.js?v=392b69dd"></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>
@@ -125,7 +125,7 @@
 
 
 
-    <p class="title logo__title">MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</p>
+    <p class="title logo__title">MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</p>
 
 </a></div>
 
@@ -464,15 +464,15 @@ <h1>All modules for which code is available</h1>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-12.
+      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-15.
       <br/>
 
   </p>
 </div>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.4.
     <br/>
   </p>
 </div>

diff --git a/dev/_modules/mne_connectivity/base.html b/dev/_modules/mne_connectivity/base.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_connectivity.base &#8212; MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</title>
+    <title>mne_connectivity.base &#8212; MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
 
-    <script src="../../_static/documentation_options.js?v=0f1ab173"></script>
+    <script src="../../_static/documentation_options.js?v=392b69dd"></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>
@@ -125,7 +125,7 @@
 
 
 
-    <p class="title logo__title">MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</p>
+    <p class="title logo__title">MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</p>
 
 </a></div>
 
@@ -1743,15 +1743,15 @@ <h1>Source code for mne_connectivity.base</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-12.
+      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-15.
       <br/>
 
   </p>
 </div>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.4.
     <br/>
   </p>
 </div>

diff --git a/dev/_modules/mne_connectivity/datasets/frequency.html b/dev/_modules/mne_connectivity/datasets/frequency.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_connectivity.datasets.frequency &#8212; MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</title>
+    <title>mne_connectivity.datasets.frequency &#8212; MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
   <script src="../../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
 
-    <script src="../../../_static/documentation_options.js?v=0f1ab173"></script>
+    <script src="../../../_static/documentation_options.js?v=392b69dd"></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>
@@ -125,7 +125,7 @@
 
 
 
-    <p class="title logo__title">MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</p>
+    <p class="title logo__title">MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</p>
 
 </a></div>
 
@@ -610,15 +610,15 @@ <h1>Source code for mne_connectivity.datasets.frequency</h1><div class="highligh
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-12.
+      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-15.
       <br/>
 
   </p>
 </div>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.4.
     <br/>
   </p>
 </div>

diff --git a/dev/_modules/mne_connectivity/decoding/decomposition.html b/dev/_modules/mne_connectivity/decoding/decomposition.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_connectivity.decoding.decomposition &#8212; MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</title>
+    <title>mne_connectivity.decoding.decomposition &#8212; MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
   <script src="../../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
 
-    <script src="../../../_static/documentation_options.js?v=0f1ab173"></script>
+    <script src="../../../_static/documentation_options.js?v=392b69dd"></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>
@@ -125,7 +125,7 @@
 
 
 
-    <p class="title logo__title">MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</p>
+    <p class="title logo__title">MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</p>
 
 </a></div>
 
@@ -1247,15 +1247,15 @@ <h1>Source code for mne_connectivity.decoding.decomposition</h1><div class="high
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-12.
+      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-15.
       <br/>
 
   </p>
 </div>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.4.
     <br/>
   </p>
 </div>

diff --git a/dev/_modules/mne_connectivity/effective.html b/dev/_modules/mne_connectivity/effective.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_connectivity.effective &#8212; MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</title>
+    <title>mne_connectivity.effective &#8212; MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
 
-    <script src="../../_static/documentation_options.js?v=0f1ab173"></script>
+    <script src="../../_static/documentation_options.js?v=392b69dd"></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>
@@ -125,7 +125,7 @@
 
 
 
-    <p class="title logo__title">MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</p>
+    <p class="title logo__title">MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</p>
 
 </a></div>
 
@@ -699,15 +699,15 @@ <h1>Source code for mne_connectivity.effective</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-12.
+      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-15.
       <br/>
 
   </p>
 </div>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.4.
     <br/>
   </p>
 </div>

diff --git a/dev/_modules/mne_connectivity/envelope.html b/dev/_modules/mne_connectivity/envelope.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_connectivity.envelope &#8212; MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</title>
+    <title>mne_connectivity.envelope &#8212; MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
 
-    <script src="../../_static/documentation_options.js?v=0f1ab173"></script>
+    <script src="../../_static/documentation_options.js?v=392b69dd"></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>
@@ -125,7 +125,7 @@
 
 
 
-    <p class="title logo__title">MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</p>
+    <p class="title logo__title">MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</p>
 
 </a></div>
 
@@ -788,15 +788,15 @@ <h1>Source code for mne_connectivity.envelope</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-12.
+      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-15.
       <br/>
 
   </p>
 </div>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.4.
     <br/>
   </p>
 </div>

diff --git a/dev/_modules/mne_connectivity/io.html b/dev/_modules/mne_connectivity/io.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_connectivity.io &#8212; MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</title>
+    <title>mne_connectivity.io &#8212; MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
 
-    <script src="../../_static/documentation_options.js?v=0f1ab173"></script>
+    <script src="../../_static/documentation_options.js?v=392b69dd"></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>
@@ -125,7 +125,7 @@
 
 
 
-    <p class="title logo__title">MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</p>
+    <p class="title logo__title">MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</p>
 
 </a></div>
 
@@ -569,15 +569,15 @@ <h1>Source code for mne_connectivity.io</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-12.
+      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-15.
       <br/>
 
   </p>
 </div>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.4.
     <br/>
   </p>
 </div>

diff --git a/dev/_modules/mne_connectivity/spectral/epochs.html b/dev/_modules/mne_connectivity/spectral/epochs.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_connectivity.spectral.epochs &#8212; MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</title>
+    <title>mne_connectivity.spectral.epochs &#8212; MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
   <script src="../../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
 
-    <script src="../../../_static/documentation_options.js?v=0f1ab173"></script>
+    <script src="../../../_static/documentation_options.js?v=392b69dd"></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>
@@ -125,7 +125,7 @@
 
 
 
-    <p class="title logo__title">MNE-Connectivity 1.8.0.dev96+g1a341b1ba documentation</p>
+    <p class="title logo__title">MNE-Connectivity 1.8.0.dev99+gc9f9bd5e9 documentation</p>
 
 </a></div>
 
@@ -1767,15 +1767,15 @@ <h1>Source code for mne_connectivity.spectral.epochs</h1><div class="highlight">
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-12.
+      © Copyright 2021-2024, MNE Developers. Last updated on 2024-07-15.
       <br/>
 
   </p>
 </div>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.4.
     <br/>
   </p>
 </div>