Skip to content

Commit

Permalink
Python: Update documentation to 0.0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
knarfS committed Jan 9, 2021
1 parent 93d8a9b commit 126b02a
Show file tree
Hide file tree
Showing 2 changed files with 1,042 additions and 982 deletions.
60 changes: 45 additions & 15 deletions doc/smuview_python_bindings.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.3.dev7+g49b7773" />
<title>smuview API documentation</title>
<meta name="description" content="The SmuView 0.0.4 Python bindings …" />
<meta name="description" content="The SmuView 0.0.5 Python bindings …" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
Expand All @@ -22,7 +22,7 @@
<h1 class="title">Module <code>smuview</code></h1>
</header>
<section id="section-intro">
<p>The SmuView 0.0.4 Python bindings.</p>
<p>The SmuView 0.0.5 Python bindings.</p>
<p>The Python bindings are a scripting extension for SmuView to automate, setup and control complex or repetitive measurements, to process the incoming data and to create a standardized user interface for those measurements.</p>
<p>The smuview module offers two default object instances: <code><a title="smuview.Session" href="#smuview.Session">Session</a></code> and <code><a title="smuview.UiProxy" href="#smuview.UiProxy">UiProxy</a></code>.
The <code><a title="smuview.Session" href="#smuview.Session">Session</a></code> object gives access to already connected devices or connects new devices. The returned device object can then be used to read data from the device or control the device.
Expand Down Expand Up @@ -404,7 +404,7 @@ <h2 id="parameters">Parameters</h2>
</code></dt>
<dd>
<div class="desc"><p>Enum of all available config keys for controlling a device.</p>
<p><strong>init</strong>(self: smuview.ConfigKey, arg0: int) -&gt; None</p></div>
<p><strong>init</strong>(self: smuview.ConfigKey, value: int) -&gt; None</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li>pybind11_builtins.pybind11_object</li>
Expand Down Expand Up @@ -732,7 +732,11 @@ <h3>Instance variables</h3>
<dl>
<dt id="smuview.ConfigKey.name"><code class="name">var <span class="ident">name</span></code></dt>
<dd>
<div class="desc"><p>(self: handle) -&gt; str</p></div>
<div class="desc"><p>name(self: handle) -&gt; str</p></div>
</dd>
<dt id="smuview.ConfigKey.value"><code class="name">var <span class="ident">value</span></code></dt>
<dd>
<div class="desc"><p>(arg0: smuview.ConfigKey) -&gt; int</p></div>
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -941,7 +945,7 @@ <h2 id="returns">Returns</h2>
</code></dt>
<dd>
<div class="desc"><p>Enum of all available data types.</p>
<p><strong>init</strong>(self: smuview.DataType, arg0: int) -&gt; None</p></div>
<p><strong>init</strong>(self: smuview.DataType, value: int) -&gt; None</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li>pybind11_builtins.pybind11_object</li>
Expand Down Expand Up @@ -1001,7 +1005,11 @@ <h3>Instance variables</h3>
<dl>
<dt id="smuview.DataType.name"><code class="name">var <span class="ident">name</span></code></dt>
<dd>
<div class="desc"><p>(self: handle) -&gt; str</p></div>
<div class="desc"><p>name(self: handle) -&gt; str</p></div>
</dd>
<dt id="smuview.DataType.value"><code class="name">var <span class="ident">value</span></code></dt>
<dd>
<div class="desc"><p>(arg0: smuview.DataType) -&gt; int</p></div>
</dd>
</dl>
</dd>
Expand All @@ -1011,7 +1019,7 @@ <h3>Instance variables</h3>
</code></dt>
<dd>
<div class="desc"><p>Enum of all possible docking locations for a view.</p>
<p><strong>init</strong>(self: smuview.DockArea, arg0: int) -&gt; None</p></div>
<p><strong>init</strong>(self: smuview.DockArea, value: int) -&gt; None</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li>pybind11_builtins.pybind11_object</li>
Expand Down Expand Up @@ -1039,7 +1047,11 @@ <h3>Instance variables</h3>
<dl>
<dt id="smuview.DockArea.name"><code class="name">var <span class="ident">name</span></code></dt>
<dd>
<div class="desc"><p>(self: handle) -&gt; str</p></div>
<div class="desc"><p>name(self: handle) -&gt; str</p></div>
</dd>
<dt id="smuview.DockArea.value"><code class="name">var <span class="ident">value</span></code></dt>
<dd>
<div class="desc"><p>(arg0: smuview.DockArea) -&gt; int</p></div>
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -1216,7 +1228,7 @@ <h3>Methods</h3>
</code></dt>
<dd>
<div class="desc"><p>Enum of all available quantities.</p>
<p><strong>init</strong>(self: smuview.Quantity, arg0: int) -&gt; None</p></div>
<p><strong>init</strong>(self: smuview.Quantity, value: int) -&gt; None</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li>pybind11_builtins.pybind11_object</li>
Expand Down Expand Up @@ -1372,7 +1384,11 @@ <h3>Instance variables</h3>
<dl>
<dt id="smuview.Quantity.name"><code class="name">var <span class="ident">name</span></code></dt>
<dd>
<div class="desc"><p>(self: handle) -&gt; str</p></div>
<div class="desc"><p>name(self: handle) -&gt; str</p></div>
</dd>
<dt id="smuview.Quantity.value"><code class="name">var <span class="ident">value</span></code></dt>
<dd>
<div class="desc"><p>(arg0: smuview.Quantity) -&gt; int</p></div>
</dd>
</dl>
</dd>
Expand All @@ -1382,7 +1398,7 @@ <h3>Instance variables</h3>
</code></dt>
<dd>
<div class="desc"><p>Enum of all available quantity flags.</p>
<p><strong>init</strong>(self: smuview.QuantityFlag, arg0: int) -&gt; None</p></div>
<p><strong>init</strong>(self: smuview.QuantityFlag, value: int) -&gt; None</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li>pybind11_builtins.pybind11_object</li>
Expand Down Expand Up @@ -1486,7 +1502,11 @@ <h3>Instance variables</h3>
<dl>
<dt id="smuview.QuantityFlag.name"><code class="name">var <span class="ident">name</span></code></dt>
<dd>
<div class="desc"><p>(self: handle) -&gt; str</p></div>
<div class="desc"><p>name(self: handle) -&gt; str</p></div>
</dd>
<dt id="smuview.QuantityFlag.value"><code class="name">var <span class="ident">value</span></code></dt>
<dd>
<div class="desc"><p>(arg0: smuview.QuantityFlag) -&gt; int</p></div>
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -1927,7 +1947,7 @@ <h2 id="returns">Returns</h2>
</code></dt>
<dd>
<div class="desc"><p>Enum of all available units.</p>
<p><strong>init</strong>(self: smuview.Unit, arg0: int) -&gt; None</p></div>
<p><strong>init</strong>(self: smuview.Unit, value: int) -&gt; None</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li>pybind11_builtins.pybind11_object</li>
Expand Down Expand Up @@ -2103,7 +2123,11 @@ <h3>Instance variables</h3>
<dl>
<dt id="smuview.Unit.name"><code class="name">var <span class="ident">name</span></code></dt>
<dd>
<div class="desc"><p>(self: handle) -&gt; str</p></div>
<div class="desc"><p>name(self: handle) -&gt; str</p></div>
</dd>
<dt id="smuview.Unit.value"><code class="name">var <span class="ident">value</span></code></dt>
<dd>
<div class="desc"><p>(arg0: smuview.Unit) -&gt; int</p></div>
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -2312,6 +2336,7 @@ <h4><code><a title="smuview.ConfigKey" href="#smuview.ConfigKey">ConfigKey</a></
<li><code><a title="smuview.ConfigKey.VoltageThreshold" href="#smuview.ConfigKey.VoltageThreshold">VoltageThreshold</a></code></li>
<li><code><a title="smuview.ConfigKey.get_data_type" href="#smuview.ConfigKey.get_data_type">get_data_type</a></code></li>
<li><code><a title="smuview.ConfigKey.name" href="#smuview.ConfigKey.name">name</a></code></li>
<li><code><a title="smuview.ConfigKey.value" href="#smuview.ConfigKey.value">value</a></code></li>
</ul>
</li>
<li>
Expand Down Expand Up @@ -2345,16 +2370,18 @@ <h4><code><a title="smuview.DataType" href="#smuview.DataType">DataType</a></cod
<li><code><a title="smuview.DataType.UInt64Range" href="#smuview.DataType.UInt64Range">UInt64Range</a></code></li>
<li><code><a title="smuview.DataType.Unknown" href="#smuview.DataType.Unknown">Unknown</a></code></li>
<li><code><a title="smuview.DataType.name" href="#smuview.DataType.name">name</a></code></li>
<li><code><a title="smuview.DataType.value" href="#smuview.DataType.value">value</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="smuview.DockArea" href="#smuview.DockArea">DockArea</a></code></h4>
<ul class="">
<ul class="two-column">
<li><code><a title="smuview.DockArea.BottomDockArea" href="#smuview.DockArea.BottomDockArea">BottomDockArea</a></code></li>
<li><code><a title="smuview.DockArea.LeftDocktArea" href="#smuview.DockArea.LeftDocktArea">LeftDocktArea</a></code></li>
<li><code><a title="smuview.DockArea.RightDockArea" href="#smuview.DockArea.RightDockArea">RightDockArea</a></code></li>
<li><code><a title="smuview.DockArea.TopDockArea" href="#smuview.DockArea.TopDockArea">TopDockArea</a></code></li>
<li><code><a title="smuview.DockArea.name" href="#smuview.DockArea.name">name</a></code></li>
<li><code><a title="smuview.DockArea.value" href="#smuview.DockArea.value">value</a></code></li>
</ul>
</li>
<li>
Expand Down Expand Up @@ -2426,6 +2453,7 @@ <h4><code><a title="smuview.Quantity" href="#smuview.Quantity">Quantity</a></cod
<li><code><a title="smuview.Quantity.Voltage" href="#smuview.Quantity.Voltage">Voltage</a></code></li>
<li><code><a title="smuview.Quantity.WindSpeed" href="#smuview.Quantity.WindSpeed">WindSpeed</a></code></li>
<li><code><a title="smuview.Quantity.name" href="#smuview.Quantity.name">name</a></code></li>
<li><code><a title="smuview.Quantity.value" href="#smuview.Quantity.value">value</a></code></li>
</ul>
</li>
<li>
Expand Down Expand Up @@ -2455,6 +2483,7 @@ <h4><code><a title="smuview.QuantityFlag" href="#smuview.QuantityFlag">QuantityF
<li><code><a title="smuview.QuantityFlag.Unknown" href="#smuview.QuantityFlag.Unknown">Unknown</a></code></li>
<li><code><a title="smuview.QuantityFlag.Unstable" href="#smuview.QuantityFlag.Unstable">Unstable</a></code></li>
<li><code><a title="smuview.QuantityFlag.name" href="#smuview.QuantityFlag.name">name</a></code></li>
<li><code><a title="smuview.QuantityFlag.value" href="#smuview.QuantityFlag.value">value</a></code></li>
</ul>
</li>
<li>
Expand Down Expand Up @@ -2532,6 +2561,7 @@ <h4><code><a title="smuview.Unit" href="#smuview.Unit">Unit</a></code></h4>
<li><code><a title="smuview.Unit.Watt" href="#smuview.Unit.Watt">Watt</a></code></li>
<li><code><a title="smuview.Unit.WattHour" href="#smuview.Unit.WattHour">WattHour</a></code></li>
<li><code><a title="smuview.Unit.name" href="#smuview.Unit.name">name</a></code></li>
<li><code><a title="smuview.Unit.value" href="#smuview.Unit.value">value</a></code></li>
</ul>
</li>
<li>
Expand Down
Loading

0 comments on commit 126b02a

Please sign in to comment.