Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@postpop
postpop committed Feb 1, 2024
1 parent 27a0497 commit ee3c7d6
Show file tree
Hide file tree
Showing 116 changed files with 756 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .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: fb8c4c863a919794fbaa987633907c63
config: 7e6f8fd8069cdb550ad20516f5454408
tags: 645f666f9bcd5a90fca523b33c5a78b7
5 changes: 4 additions & 1 deletion README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -269,7 +270,7 @@ <h1>Ethodrome documentation<a class="headerlink" href="#ethodrome-documentation"
<p>The docs are published at <span class="xref myst">https://janclemenslab.org/ethodrome</span>.</p>
<p>Requires:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">install</span> <span class="pre">sphinx</span> <span class="pre">furo</span> <span class="pre">sphinx-inline-tabs</span> <span class="pre">ghp-import</span> <span class="pre">myst-nb</span> <span class="pre">sphinx-panels</span> <span class="pre">-c</span> <span class="pre">conda-forge</span></code> # need the latest version for proper light/dark mode</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">install</span> <span class="pre">sphinx</span> <span class="pre">furo</span> <span class="pre">sphinx-inline-tabs</span> <span class="pre">sphinx-copybutton</span> <span class="pre">ghp-import</span> <span class="pre">myst-nb</span> <span class="pre">sphinx-panels</span> <span class="pre">-c</span> <span class="pre">conda-forge</span></code> # need the latest version for proper light/dark mode</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">sphinxcontrib-images</span></code></p></li>
</ul>
<section id="build">
Expand Down Expand Up @@ -342,6 +343,8 @@ <h2>Publish<a class="headerlink" href="#publish" title="Permalink to this headli
<script src="_static/scripts/furo.js"></script>
<script src="_static/togglebutton.js"></script>
<script src="_static/tabs.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/call/client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -691,6 +692,8 @@ <h1>Source code for etho.call.client</h1><div class="highlight"><pre>
<script src="../../../_static/scripts/furo.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script src="../../../_static/tabs.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/call/client_old.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -679,6 +680,8 @@ <h1>Source code for etho.call.client_old</h1><div class="highlight"><pre>
<script src="../../../_static/scripts/furo.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script src="../../../_static/tabs.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/cli.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -506,6 +507,8 @@ <h1>Source code for etho.cli</h1><div class="highlight"><pre>
<script src="../../_static/scripts/furo.js"></script>
<script src="../../_static/togglebutton.js"></script>
<script src="../../_static/tabs.js"></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/gui/app.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -763,6 +764,8 @@ <h1>Source code for etho.gui.app</h1><div class="highlight"><pre>
<script src="../../../_static/scripts/furo.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script src="../../../_static/tabs.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/gui/wxBusyDialog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -355,6 +356,8 @@ <h1>Source code for etho.gui.wxBusyDialog</h1><div class="highlight"><pre>
<script src="../../../_static/scripts/furo.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script src="../../../_static/tabs.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/gui/wxCam.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -367,6 +368,8 @@ <h1>Source code for etho.gui.wxCam</h1><div class="highlight"><pre>
<script src="../../../_static/scripts/furo.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script src="../../../_static/tabs.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/gui/wxCtrl.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -406,6 +407,8 @@ <h1>Source code for etho.gui.wxCtrl</h1><div class="highlight"><pre>
<script src="../../../_static/scripts/furo.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script src="../../../_static/tabs.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/gui/wxCtrl_ephys.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -394,6 +395,8 @@ <h1>Source code for etho.gui.wxCtrl_ephys</h1><div class="highlight"><pre>
<script src="../../../_static/scripts/furo.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script src="../../../_static/tabs.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/gui/wxCtrl_rpi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -424,6 +425,8 @@ <h1>Source code for etho.gui.wxCtrl_rpi</h1><div class="highlight"><pre>
<script src="../../../_static/scripts/furo.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script src="../../../_static/tabs.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
3 changes: 3 additions & 0 deletions _modules/etho/gui/wxCtrl_vr.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
Expand Down Expand Up @@ -414,6 +415,8 @@ <h1>Source code for etho.gui.wxCtrl_vr</h1><div class="highlight"><pre>
<script src="../../../_static/scripts/furo.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script src="../../../_static/tabs.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
Expand Down
Loading

0 comments on commit ee3c7d6

Please sign in to comment.