Skip to content

Commit

Permalink
doc updates [skip ci] (1223)
Browse files Browse the repository at this point in the history
  • Loading branch information
Circle Ci committed Aug 20, 2024
1 parent 7018ff3 commit 7dbccf4
Show file tree
Hide file tree
Showing 104 changed files with 822 additions and 712 deletions.
2 changes: 1 addition & 1 deletion dev/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: 60cdbe38f21805636d99e02a1e913312
config: 7acd5ba8cf41f20c4eb8808c64b5e344
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/0e2cac543ebccdb0eddca96bb909d43a/cacoh.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/0fe046d410690dd02441adbdb94740c0/mixed_source_space_connectivity.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/15d5720b7c9da8789e8399a45f5feac9/mne_inverse_envelope_correlation.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/1de2d9313328ac7a0580e229b8a5cbbc/mne_inverse_label_connectivity.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/1f1893579bb597251e98a3bde46e316f/granger_causality.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/348ea9dd9d83b9841ec181fcf6820999/cohy_decomposition_plotting.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/5a7e4b04d139bf223ad6c4a43af76dcd/cohy_decomposition.zip
View file
Binary file not shown.
Binary file modified ..._downloads/5b4c04b6c84ce2fd08b907a8b5d0e7d1/compare_connectivity_over_time_over_trial.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/5d710507a772f60c05c894f77a15f158/connectivity_classes.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/71147ba97f82e69ff8b49d0342b9a589/mne_inverse_coherence_epochs.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/83598d1d801de7e37ea5fe0a19e0a4fc/cwt_sensor_connectivity.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/8cb2e6ba3da421678a517077a9590a3c/mne_var_connectivity.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/8f8ea11e72191775746dd7cc0d761e6a/mne_inverse_psi_visual.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/947727abe2944e1337e111fe1a47dcde/sensor_connectivity.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/9bb5cf4c4ac8dd134e16d5b90ca7c4fe/mne_inverse_connectivity_spectrum.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/a2f678085d65b181d85eef728e9f4aa7/mic_mim.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/a6553535315fe003837975c763e28ecf/compare_coherency_methods.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/b5626e9a9c504cb943b32de3dd6197c9/dpli_wpli_pli.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/c8df8b748262c4852e771fae4c665b59/mne_inverse_envelope_correlation_volume.zip
View file
Binary file not shown.
Binary file modified dev/_downloads/d7f2c5fcd3f646e25c5a522067368f75/handling_ragged_arrays.zip
View file
Binary file not shown.
Binary file modified dev/_images/sphx_glr_dpli_wpli_pli_001.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_dpli_wpli_pli_002.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_dpli_wpli_pli_004.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_dpli_wpli_pli_thumb.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions dev/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.dev145+gc9f8ee299 documentation</title>
<title>Overview: module code &#8212; MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</title>



Expand Down Expand Up @@ -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=770cf683"></script>
<script src="../_static/documentation_options.js?v=0c79fd03"></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>
Expand Down Expand Up @@ -125,7 +125,7 @@



<p class="title logo__title">MNE-Connectivity 1.8.0.dev145+gc9f8ee299 documentation</p>
<p class="title logo__title">MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</p>

</a></div>

Expand Down Expand Up @@ -464,7 +464,7 @@ <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-08-13.
© Copyright 2021-2024, MNE Developers. Last updated on 2024-08-20.
<br/>

</p>
Expand Down
8 changes: 4 additions & 4 deletions dev/_modules/mne_connectivity/base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.dev145+gc9f8ee299 documentation</title>
<title>mne_connectivity.base &#8212; MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</title>



Expand Down Expand Up @@ -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=770cf683"></script>
<script src="../../_static/documentation_options.js?v=0c79fd03"></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>
Expand Down Expand Up @@ -125,7 +125,7 @@



<p class="title logo__title">MNE-Connectivity 1.8.0.dev145+gc9f8ee299 documentation</p>
<p class="title logo__title">MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</p>

</a></div>

Expand Down Expand Up @@ -1764,7 +1764,7 @@ <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-08-13.
© Copyright 2021-2024, MNE Developers. Last updated on 2024-08-20.
<br/>

</p>
Expand Down
8 changes: 4 additions & 4 deletions dev/_modules/mne_connectivity/datasets/frequency.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.dev145+gc9f8ee299 documentation</title>
<title>mne_connectivity.datasets.frequency &#8212; MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</title>



Expand Down Expand Up @@ -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=770cf683"></script>
<script src="../../../_static/documentation_options.js?v=0c79fd03"></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>
Expand Down Expand Up @@ -125,7 +125,7 @@



<p class="title logo__title">MNE-Connectivity 1.8.0.dev145+gc9f8ee299 documentation</p>
<p class="title logo__title">MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</p>

</a></div>

Expand Down Expand Up @@ -610,7 +610,7 @@ <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-08-13.
© Copyright 2021-2024, MNE Developers. Last updated on 2024-08-20.
<br/>

</p>
Expand Down
21 changes: 10 additions & 11 deletions dev/_modules/mne_connectivity/decoding/decomposition.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.dev145+gc9f8ee299 documentation</title>
<title>mne_connectivity.decoding.decomposition &#8212; MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</title>



Expand Down Expand Up @@ -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=770cf683"></script>
<script src="../../../_static/documentation_options.js?v=0c79fd03"></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>
Expand Down Expand Up @@ -125,7 +125,7 @@



<p class="title logo__title">MNE-Connectivity 1.8.0.dev145+gc9f8ee299 documentation</p>
<p class="title logo__title">MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</p>

</a></div>

Expand Down Expand Up @@ -420,7 +420,6 @@ <h1>Source code for mne_connectivity.decoding.decomposition</h1><div class="high
<span class="c1">#</span>
<span class="c1"># License: BSD (3-clause)</span>

<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">mne</span> <span class="kn">import</span> <span class="n">Info</span>
Expand Down Expand Up @@ -499,12 +498,12 @@ <h1>Source code for mne_connectivity.decoding.decomposition</h1><div class="high
<span class="sd"> .. footbibliography::</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">filters_</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">tuple</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">patterns_</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">tuple</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">filters_</span><span class="p">:</span> <span class="nb">tuple</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">patterns_</span><span class="p">:</span> <span class="nb">tuple</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>

<span class="n">_conn_estimator</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">_CaCohEst</span><span class="p">,</span> <span class="n">_MICEst</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_indices</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">tuple</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_rank</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">tuple</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_conn_estimator</span><span class="p">:</span> <span class="n">_CaCohEst</span> <span class="o">|</span> <span class="n">_MICEst</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_indices</span><span class="p">:</span> <span class="nb">tuple</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_rank</span><span class="p">:</span> <span class="nb">tuple</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">indices</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
Expand Down Expand Up @@ -617,7 +616,7 @@ <h1>Source code for mne_connectivity.decoding.decomposition</h1><div class="high
<span class="s2">&quot;`cwt_n_cycles`&quot;</span><span class="p">,</span>
<span class="s2">&quot;int, float, or array-like&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cwt_n_cycles</span><span class="p">,</span> <span class="p">(</span><span class="nb">tuple</span><span class="p">,</span> <span class="nb">list</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">))</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cwt_n_cycles</span><span class="p">,</span> <span class="nb">tuple</span> <span class="o">|</span> <span class="nb">list</span> <span class="o">|</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span>
<span class="n">cwt_n_cycles</span>
<span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">cwt_freqs</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
Expand Down Expand Up @@ -1240,7 +1239,7 @@ <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-08-13.
© Copyright 2021-2024, MNE Developers. Last updated on 2024-08-20.
<br/>

</p>
Expand Down
8 changes: 4 additions & 4 deletions dev/_modules/mne_connectivity/effective.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.dev145+gc9f8ee299 documentation</title>
<title>mne_connectivity.effective &#8212; MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</title>



Expand Down Expand Up @@ -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=770cf683"></script>
<script src="../../_static/documentation_options.js?v=0c79fd03"></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>
Expand Down Expand Up @@ -125,7 +125,7 @@



<p class="title logo__title">MNE-Connectivity 1.8.0.dev145+gc9f8ee299 documentation</p>
<p class="title logo__title">MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</p>

</a></div>

Expand Down Expand Up @@ -699,7 +699,7 @@ <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-08-13.
© Copyright 2021-2024, MNE Developers. Last updated on 2024-08-20.
<br/>

</p>
Expand Down
8 changes: 4 additions & 4 deletions dev/_modules/mne_connectivity/envelope.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.dev145+gc9f8ee299 documentation</title>
<title>mne_connectivity.envelope &#8212; MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</title>



Expand Down Expand Up @@ -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=770cf683"></script>
<script src="../../_static/documentation_options.js?v=0c79fd03"></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>
Expand Down Expand Up @@ -125,7 +125,7 @@



<p class="title logo__title">MNE-Connectivity 1.8.0.dev145+gc9f8ee299 documentation</p>
<p class="title logo__title">MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</p>

</a></div>

Expand Down Expand Up @@ -788,7 +788,7 @@ <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-08-13.
© Copyright 2021-2024, MNE Developers. Last updated on 2024-08-20.
<br/>

</p>
Expand Down
8 changes: 4 additions & 4 deletions dev/_modules/mne_connectivity/io.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.dev145+gc9f8ee299 documentation</title>
<title>mne_connectivity.io &#8212; MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</title>



Expand Down Expand Up @@ -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=770cf683"></script>
<script src="../../_static/documentation_options.js?v=0c79fd03"></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>
Expand Down Expand Up @@ -125,7 +125,7 @@



<p class="title logo__title">MNE-Connectivity 1.8.0.dev145+gc9f8ee299 documentation</p>
<p class="title logo__title">MNE-Connectivity 1.9.0.dev5+g966121be5 documentation</p>

</a></div>

Expand Down Expand Up @@ -569,7 +569,7 @@ <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-08-13.
© Copyright 2021-2024, MNE Developers. Last updated on 2024-08-20.
<br/>

</p>
Expand Down
Loading

0 comments on commit 7dbccf4

Please sign in to comment.