CircleCI update of docs (442).

LABSN · Jul 3, 2023 · 07301ed · 07301ed
1 parent c651d7e
commit 07301ed
Show file tree

Hide file tree

Showing 21 changed files with 89 additions and 89 deletions.
diff --git a/mnefun/generated/mnefun.Params.html b/mnefun/generated/mnefun.Params.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>mnefun.Params &#8212; mnefun 0.2.0.dev0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -197,8 +197,8 @@ <h1>mnefun.Params<a class="headerlink" href="#mnefun-params" title="Permalink to
     </p>
     <p>
         &copy; Copyright 2013-2023, mnefun Developers.<br/>
-      Last updated on Apr 04, 2023.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 6.1.3.<br/>
+      Last updated on Jul 03, 2023.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.0.1.<br/>
     </p>
   </div>
 </footer>

diff --git a/mnefun/generated/mnefun.anova_time.html b/mnefun/generated/mnefun.anova_time.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>mnefun.anova_time &#8212; mnefun 0.2.0.dev0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -105,7 +105,7 @@ <h1>mnefun.anova_time<a class="headerlink" href="#mnefun-anova-time" title="Perm
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl>
-<dt><strong>X</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>X should have the following dimensions:</p>
+<dt><strong>X</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>X should have the following dimensions:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">n_subjects</span><span class="p">,</span> <span class="mi">2</span> <span class="o">*</span> <span class="n">n_time</span><span class="p">,</span> <span class="n">n_src</span><span class="p">)</span>
 </pre></div>
 </div>
@@ -126,10 +126,10 @@ <h1>mnefun.anova_time<a class="headerlink" href="#mnefun-anova-time" title="Perm
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><dl>
-<dt><strong>t</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>t-values from the contrast, has the same length as the number of
+<dt><strong>t</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>t-values from the contrast, has the same length as the number of
 spatial locations.</p>
 </dd>
-<dt><strong>p</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>Corresponding p values of the contrast.</p>
+<dt><strong>p</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>Corresponding p values of the contrast.</p>
 </dd>
 <dt><strong>dof</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a></span></dt><dd><p>Degrees of freedom, with conservative Greenhouse-Geisser
 correction based on the number of time points (n_time - 1).</p>
@@ -154,8 +154,8 @@ <h1>mnefun.anova_time<a class="headerlink" href="#mnefun-anova-time" title="Perm
     </p>
     <p>
         &copy; Copyright 2013-2023, mnefun Developers.<br/>
-      Last updated on Apr 04, 2023.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 6.1.3.<br/>
+      Last updated on Jul 03, 2023.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.0.1.<br/>
     </p>
   </div>
 </footer>

diff --git a/mnefun/generated/mnefun.convert_ANTS_surrogate.html b/mnefun/generated/mnefun.convert_ANTS_surrogate.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>mnefun.convert_ANTS_surrogate &#8212; mnefun 0.2.0.dev0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -141,8 +141,8 @@ <h1>mnefun.convert_ANTS_surrogate<a class="headerlink" href="#mnefun-convert-ant
     </p>
     <p>
         &copy; Copyright 2013-2023, mnefun Developers.<br/>
-      Last updated on Apr 04, 2023.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 6.1.3.<br/>
+      Last updated on Jul 03, 2023.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.0.1.<br/>
     </p>
   </div>
 </footer>

diff --git a/mnefun/generated/mnefun.do_processing.html b/mnefun/generated/mnefun.do_processing.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>mnefun.do_processing &#8212; mnefun 0.2.0.dev0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -155,8 +155,8 @@ <h1>mnefun.do_processing<a class="headerlink" href="#mnefun-do-processing" title
     </p>
     <p>
         &copy; Copyright 2013-2023, mnefun Developers.<br/>
-      Last updated on Apr 04, 2023.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 6.1.3.<br/>
+      Last updated on Jul 03, 2023.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.0.1.<br/>
     </p>
   </div>
 </footer>

diff --git a/mnefun/generated/mnefun.extract_expyfun_events.html b/mnefun/generated/mnefun.extract_expyfun_events.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>mnefun.extract_expyfun_events &#8212; mnefun 0.2.0.dev0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -114,15 +114,15 @@ <h1>mnefun.extract_expyfun_events<a class="headerlink" href="#mnefun-extract-exp
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><dl>
-<dt><strong>events</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>Array of events of shape (N, 3), re-coded such that 1 triggers
+<dt><strong>events</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>Array of events of shape (N, 3), re-coded such that 1 triggers
 are renamed according to their binary expyfun representation.</p>
 </dd>
-<dt><strong>presses</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ndarray</span></code></a></span></dt><dd><p>List of all press events that occurred between each one
+<dt><strong>presses</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ndarray</span></code></a></span></dt><dd><p>List of all press events that occurred between each one
 trigger. Each array has shape (N_presses,). If return_offset is True,
 then each array has shape (N_presses, 2), with the first column
 as the time offset from the trial trigger.</p>
 </dd>
-<dt><strong>orig_events</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>Original events array.</p>
+<dt><strong>orig_events</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>Original events array.</p>
 </dd>
 </dl>
 </dd>
@@ -150,8 +150,8 @@ <h1>mnefun.extract_expyfun_events<a class="headerlink" href="#mnefun-extract-exp
     </p>
     <p>
         &copy; Copyright 2013-2023, mnefun Developers.<br/>
-      Last updated on Apr 04, 2023.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 6.1.3.<br/>
+      Last updated on Jul 03, 2023.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.0.1.<br/>
     </p>
   </div>
 </footer>

diff --git a/mnefun/generated/mnefun.get_atlas_mapping.html b/mnefun/generated/mnefun.get_atlas_mapping.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>mnefun.get_atlas_mapping &#8212; mnefun 0.2.0.dev0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -133,8 +133,8 @@ <h1>mnefun.get_atlas_mapping<a class="headerlink" href="#mnefun-get-atlas-mappin
     </p>
     <p>
         &copy; Copyright 2013-2023, mnefun Developers.<br/>
-      Last updated on Apr 04, 2023.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 6.1.3.<br/>
+      Last updated on Jul 03, 2023.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.0.1.<br/>
     </p>
   </div>
 </footer>

diff --git a/mnefun/generated/mnefun.get_atlas_roi_mask.html b/mnefun/generated/mnefun.get_atlas_roi_mask.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>mnefun.get_atlas_roi_mask &#8212; mnefun 0.2.0.dev0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -105,7 +105,7 @@ <h1>mnefun.get_atlas_roi_mask<a class="headerlink" href="#mnefun-get-atlas-roi-m
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl>
-<dt><strong>stc</strong><span class="classifier">instance of <a class="reference external" href="https://mne.tools/dev/generated/mne.SourceEstimate.html#mne.SourceEstimate" title="(in MNE v1.4)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mne.SourceEstimate</span></code></a> or <a class="reference external" href="https://mne.tools/dev/generated/mne.VectorSourceEstimate.html#mne.VectorSourceEstimate" title="(in MNE v1.4)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mne.VectorSourceEstimate</span></code></a></span></dt><dd><p>The source estimate.</p>
+<dt><strong>stc</strong><span class="classifier">instance of <a class="reference external" href="https://mne.tools/dev/generated/mne.SourceEstimate.html#mne.SourceEstimate" title="(in MNE v1.5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mne.SourceEstimate</span></code></a> or <a class="reference external" href="https://mne.tools/dev/generated/mne.VectorSourceEstimate.html#mne.VectorSourceEstimate" title="(in MNE v1.5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mne.VectorSourceEstimate</span></code></a></span></dt><dd><p>The source estimate.</p>
 </dd>
 <dt><strong>roi</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>The ROI to obtain a mask for.</p>
 </dd>
@@ -119,7 +119,7 @@ <h1>mnefun.get_atlas_roi_mask<a class="headerlink" href="#mnefun-get-atlas-roi-m
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><dl>
-<dt><strong>mask</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ndarray</span></code></a>, shape (n_vertices,)</span></dt><dd><p>The mask.</p>
+<dt><strong>mask</strong><span class="classifier"><a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ndarray</span></code></a>, shape (n_vertices,)</span></dt><dd><p>The mask.</p>
 </dd>
 </dl>
 </dd>
@@ -141,8 +141,8 @@ <h1>mnefun.get_atlas_roi_mask<a class="headerlink" href="#mnefun-get-atlas-roi-m
     </p>
     <p>
         &copy; Copyright 2013-2023, mnefun Developers.<br/>
-      Last updated on Apr 04, 2023.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 6.1.3.<br/>
+      Last updated on Jul 03, 2023.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.0.1.<br/>
     </p>
   </div>
 </footer>

diff --git a/mnefun/generated/mnefun.get_fsaverage_medial_vertices.html b/mnefun/generated/mnefun.get_fsaverage_medial_vertices.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>mnefun.get_fsaverage_medial_vertices &#8212; mnefun 0.2.0.dev0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -121,7 +121,7 @@ <h1>mnefun.get_fsaverage_medial_vertices<a class="headerlink" href="#mnefun-get-
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><dl>
-<dt><strong>vertices</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a>, or <a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>The medial wall vertices.</p>
+<dt><strong>vertices</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a>, or <a class="reference external" href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a></span></dt><dd><p>The medial wall vertices.</p>
 </dd>
 </dl>
 </dd>
@@ -143,8 +143,8 @@ <h1>mnefun.get_fsaverage_medial_vertices<a class="headerlink" href="#mnefun-get-
     </p>
     <p>
         &copy; Copyright 2013-2023, mnefun Developers.<br/>
-      Last updated on Apr 04, 2023.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 6.1.3.<br/>
+      Last updated on Jul 03, 2023.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.0.1.<br/>
     </p>
   </div>
 </footer>