Skip to content

Commit

Permalink
v0.7.8 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@gutow
gutow committed Jul 15, 2022
1 parent f1b08bc commit 6a27155
Show file tree
Hide file tree
Showing 16 changed files with 1,997 additions and 1,477 deletions.
15 changes: 11 additions & 4 deletions docs/jupyterpidaq.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,12 @@ <h2>Submodules</h2>
<li><a href="jupyterpidaq/Boards.html">Boards</a></li>
<li><a href="jupyterpidaq/ChannelSettings.html">ChannelSettings</a></li>
<li><a href="jupyterpidaq/DAQProc.html">DAQProc</a></li>
<li><a href="jupyterpidaq/DAQinstance.html">DAQinstance</a></li>
<li><a href="jupyterpidaq/Sensors.html">Sensors</a></li>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down Expand Up @@ -145,7 +146,7 @@ <h3 id="starting-jupyterpidaq">Starting JupyterPiDAQ</h3>
<h3 id="initialize-the-data-acquisition-tools">Initialize the Data Acquisition Tools</h3>

<p>Initialize the data acquisition tools by putting the statement <code>from
jupyterpidaq.DAQinstance import *</code> into the first cell and clicking on the
<a href="jupyterpidaq/DAQinstance.html">jupyterpidaq.DAQinstance</a> import *</code> into the first cell and clicking on the
'Run' button. The package loads supporting packages (numpy, pandas, plotly,
etc...) and searches for compatible hardware. On a Raspberry Pi this takes a
number of seconds. If no compatible A-to-D boards are found, demo mode is used.
Expand Down Expand Up @@ -392,7 +393,7 @@ <h2 id="final-set-up">Final Set Up</h2>
<ol>
<li>Open a new notebook using the default (Python 3) kernel.</li>
<li>In the first cell import all from DAQinstance.py:
<code>from jupyterpidaq.DAQinstance import *</code>.
<code>from <a href="jupyterpidaq/DAQinstance.html">jupyterpidaq.DAQinstance</a> import *</code>.
When run this cell should load the DAQmenu at the end of the Jupyter
notebook menu/icon bar. If you do not have an appropriate A-to-D
board installed you will get a message and the software
Expand Down Expand Up @@ -454,7 +455,7 @@ <h2 id="setting-up-development-environment">Setting up Development Environment</
<ol>
<li>Open a new notebook using the default (Python 3) kernel.</li>
<li>In the first cell import all from DAQinstance.py:
<code>from jupyterpidaq.DAQinstance import *</code>.
<code>from <a href="jupyterpidaq/DAQinstance.html">jupyterpidaq.DAQinstance</a> import *</code>.
When run this cell should load the DAQmenu at the end of the
Jupyter notebook menu/icon bar. If you do not have an appropriate A-to-D
board installed you will get a message and the software
Expand Down Expand Up @@ -568,6 +569,12 @@ <h2 id="releasing-on-pypi">Releasing on PyPi</h2>
<h1 id="change-log">Change Log</h1>

<ul>
<li>0.7.8
<ul>
<li>Updated text for insertion into cells to make better use of escaping
updates in JPSLUtils &gt;=0.7.0.</li>
<li>Removed some unnecessary print statements.</li>
</ul></li>
<li>0.7.7
<ul>
<li>Updated requirements for upstream security fixes.</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Boards.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h2>Submodules</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Boards/PiGPIO.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h2>Submodules</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Boards/PiGPIO/ADS1115.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ <h2>API Documentation</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Boards/PiGPIO/DAQC2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ <h2>API Documentation</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Boards/Simulated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h2>Submodules</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Boards/Simulated/ADCsim.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ <h2>API Documentation</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Boards/Simulated/ADCsim_line.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ <h2>API Documentation</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Boards/boards.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h2>API Documentation</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/ChannelSettings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ <h2>API Documentation</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/DAQProc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ <h2>API Documentation</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
3,431 changes: 1,972 additions & 1,459 deletions docs/jupyterpidaq/DAQinstance.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Sensors.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h2>Submodules</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyterpidaq/Sensors/sensors.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ <h2>API Documentation</h2>
</ul>


<footer>JupyterPiDAQ v0.7.7</footer>
<footer>JupyterPiDAQ v0.7.8</footer>

<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
Expand Down
2 changes: 1 addition & 1 deletion docs/search.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
'notebook>=6.4.12', # security fixes
'jupyter-contrib-nbextensions>=0.5.1',
'pandas>=1.4.2',
'jupyter-pandas-GUI>=0.6.2.1',
'jupyter-pandas-GUI>=0.7.0',
'JPSLMenus>=0.5.0',
'JPSLUtils>=0.7.0',
'AdvancedHTMLParser>=9.0.1'
Expand Down

0 comments on commit 6a27155

Please sign in to comment.