Skip to content

Commit

Permalink
doc updates [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Circle Ci committed Aug 24, 2024
1 parent db8e639 commit fd34fc2
Show file tree
Hide file tree
Showing 92 changed files with 350 additions and 349 deletions.
2 changes: 1 addition & 1 deletion dev/.buildinfo
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: 6928f7c7e51b93da8d239a370853b6cf
config: 02d45714a757fde7ce318df544b529b3
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/701f5b32d08455f1c1e98b7ab1715881/bidspath.zip
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
6 changes: 3 additions & 3 deletions dev/_modules/index.html
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-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>Overview: module code &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/_modules/mne_bids/copyfiles.html
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_bids.copyfiles &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.copyfiles &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/_modules/mne_bids/dig.html
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_bids.dig &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.dig &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/_modules/mne_bids/inspect.html
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_bids.inspect &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.inspect &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/_modules/mne_bids/path.html
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_bids.path &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.path &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/_modules/mne_bids/read.html
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_bids.read &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.read &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/_modules/mne_bids/report/_report.html
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_bids.report._report &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.report._report &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/_modules/mne_bids/sidecar_updates.html
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_bids.sidecar_updates &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.sidecar_updates &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/_modules/mne_bids/stats.html
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_bids.stats &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.stats &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/_modules/mne_bids/utils.html
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_bids.utils &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.utils &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
8 changes: 4 additions & 4 deletions dev/_modules/mne_bids/write.html
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_bids.write &#8212; MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</title>
<title>mne_bids.write &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="../../_static/documentation_options.js?v=6730b44c"></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 @@ -147,7 +147,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down Expand Up @@ -989,7 +989,7 @@ <h1>Source code for mne_bids.write</h1><div class="highlight"><pre>

<span class="c1"># determine the age of the participant</span>
<span class="n">age</span> <span class="o">=</span> <span class="n">subject_info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;birthday&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">age</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span> <span class="c1"># can be removed once MNE &gt;= 1.8 is required</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">age</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span> <span class="c1"># XXX: can be removed once MNE &gt;= 1.8 is required</span>
<span class="n">age</span> <span class="o">=</span> <span class="n">date</span><span class="p">(</span><span class="o">*</span><span class="n">age</span><span class="p">)</span>
<span class="n">meas_date</span> <span class="o">=</span> <span class="n">raw</span><span class="o">.</span><span class="n">info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;meas_date&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">meas_date</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>
Expand Down
2 changes: 1 addition & 1 deletion dev/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.16.0.dev30+ga4759bf0',
VERSION: '0.16.0.dev31+g8c22bcf4',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
6 changes: 3 additions & 3 deletions dev/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.dev30+ga4759bf0 documentation</title>
<title>API Documentation &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="_static/documentation_options.js?v=6730b44c"></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 @@ -150,7 +150,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
6 changes: 3 additions & 3 deletions dev/authors.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.dev30+ga4759bf0 documentation</title>
<title>&lt;no title&gt; &#8212; MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</title>



Expand Down Expand Up @@ -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=c66c7566"></script>
<script src="_static/documentation_options.js?v=6730b44c"></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 @@ -148,7 +148,7 @@



<p class="title logo__title">MNE-BIDS 0.16.0.dev30+ga4759bf0 documentation</p>
<p class="title logo__title">MNE-BIDS 0.16.0.dev31+g8c22bcf4 documentation</p>

</a></div>

Expand Down
Loading

0 comments on commit fd34fc2

Please sign in to comment.