Skip to content

Commit 5f35bb2

Browse files
AnthonyZJiangAnthonyZJiang
committed
doc update
1 parent 8024b05 commit 5f35bb2

File tree

7 files changed

+0
-171
lines changed

7 files changed

+0
-171
lines changed

‎docs/isotope/port/adc_input.html‎

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -94,29 +94,6 @@ <h3>Ancestors</h3>
9494
<li><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></li>
9595
<li>typing.Generic</li>
9696
</ul>
97-
<h3>Methods</h3>
98-
<dl>
99-
<dt id="isotope.port.adc_input.ADCInput.__getitem__"><code class="name flex">
100-
<span>def <span class="ident">__getitem__</span></span>(<span>self, key: int) ‑> ~T</span>
101-
</code></dt>
102-
<dd>
103-
<p class="inheritance">
104-
<em>Inherited from:</em>
105-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__getitem__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__getitem__">__getitem__</a></code>
106-
</p>
107-
<div class="desc inherited"><p>Get the specific IsotopePort object by index …</p></div>
108-
</dd>
109-
<dt id="isotope.port.adc_input.ADCInput.__len__"><code class="name flex">
110-
<span>def <span class="ident">__len__</span></span>(<span>self) ‑> int</span>
111-
</code></dt>
112-
<dd>
113-
<p class="inheritance">
114-
<em>Inherited from:</em>
115-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__len__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__len__">__len__</a></code>
116-
</p>
117-
<div class="desc inherited"><p>Get the number of ports …</p></div>
118-
</dd>
119-
</dl>
12097
</dd>
12198
<dt id="isotope.port.adc_input.ADCInputPort"><code class="flex name class">
12299
<span>class <span class="ident">ADCInputPort</span></span>
@@ -268,10 +245,6 @@ <h2 id="returns">Returns</h2>
268245
<ul>
269246
<li>
270247
<h4><code><a title="isotope.port.adc_input.ADCInput" href="#isotope.port.adc_input.ADCInput">ADCInput</a></code></h4>
271-
<ul class="">
272-
<li><code><a title="isotope.port.adc_input.ADCInput.__getitem__" href="isotope_port.html#isotope.port.adc_input.ADCInput.__getitem__">__getitem__</a></code></li>
273-
<li><code><a title="isotope.port.adc_input.ADCInput.__len__" href="isotope_port.html#isotope.port.adc_input.ADCInput.__len__">__len__</a></code></li>
274-
</ul>
275248
</li>
276249
<li>
277250
<h4><code><a title="isotope.port.adc_input.ADCInputPort" href="#isotope.port.adc_input.ADCInputPort">ADCInputPort</a></code></h4>

‎docs/isotope/port/isotope_port.html‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -199,38 +199,6 @@ <h3>Subclasses</h3>
199199
<li><a title="isotope.port.pwm_output.PWMOutput" href="pwm_output.html#isotope.port.pwm_output.PWMOutput">PWMOutput</a></li>
200200
<li><a title="isotope.port.temp_input.TempInput" href="temp_input.html#isotope.port.temp_input.TempInput">TempInput</a></li>
201201
</ul>
202-
<h3>Methods</h3>
203-
<dl>
204-
<dt id="isotope.port.isotope_port.IsotopePortContainer.__getitem__"><code class="name flex">
205-
<span>def <span class="ident">__getitem__</span></span>(<span>self, key: int) ‑> ~T</span>
206-
</code></dt>
207-
<dd>
208-
<div class="desc"><p>Get the specific IsotopePort object by index.</p>
209-
<p>Implements the <code>[]</code> operator to get the IsotopePort object by index, e.g. <code>port[0]</code>.</p>
210-
<h2 id="args">Args</h2>
211-
<dl>
212-
<dt><strong><code>key</code></strong> :&ensp;<code>int</code></dt>
213-
<dd>The index of the motor port.</dd>
214-
</dl>
215-
<h2 id="returns">Returns</h2>
216-
<dl>
217-
<dt><code>T</code></dt>
218-
<dd>The IsotopePort object.</dd>
219-
</dl></div>
220-
</dd>
221-
<dt id="isotope.port.isotope_port.IsotopePortContainer.__len__"><code class="name flex">
222-
<span>def <span class="ident">__len__</span></span>(<span>self) ‑> int</span>
223-
</code></dt>
224-
<dd>
225-
<div class="desc"><p>Get the number of ports.</p>
226-
<p>Implements the <code>len()</code> function to return the number of ports in the container.</p>
227-
<h2 id="returns">Returns</h2>
228-
<dl>
229-
<dt><code>int</code></dt>
230-
<dd>The number of ports.</dd>
231-
</dl></div>
232-
</dd>
233-
</dl>
234202
</dd>
235203
<dt id="isotope.port.isotope_port.PortException"><code class="flex name class">
236204
<span>class <span class="ident">PortException</span></span>
@@ -325,10 +293,6 @@ <h4><code><a title="isotope.port.isotope_port.IsotopePort" href="#isotope.port.i
325293
</li>
326294
<li>
327295
<h4><code><a title="isotope.port.isotope_port.IsotopePortContainer" href="#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code></h4>
328-
<ul class="">
329-
<li><code><a title="isotope.port.isotope_port.IsotopePortContainer.__getitem__" href="#isotope.port.isotope_port.IsotopePortContainer.__getitem__">__getitem__</a></code></li>
330-
<li><code><a title="isotope.port.isotope_port.IsotopePortContainer.__len__" href="#isotope.port.isotope_port.IsotopePortContainer.__len__">__len__</a></code></li>
331-
</ul>
332296
</li>
333297
<li>
334298
<h4><code><a title="isotope.port.isotope_port.PortException" href="#isotope.port.isotope_port.PortException">PortException</a></code></h4>

‎docs/isotope/port/motor.html‎

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -116,29 +116,6 @@ <h3>Ancestors</h3>
116116
<li><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></li>
117117
<li>typing.Generic</li>
118118
</ul>
119-
<h3>Methods</h3>
120-
<dl>
121-
<dt id="isotope.port.motor.Motor.__getitem__"><code class="name flex">
122-
<span>def <span class="ident">__getitem__</span></span>(<span>self, key: int) ‑> ~T</span>
123-
</code></dt>
124-
<dd>
125-
<p class="inheritance">
126-
<em>Inherited from:</em>
127-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__getitem__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__getitem__">__getitem__</a></code>
128-
</p>
129-
<div class="desc inherited"><p>Get the specific IsotopePort object by index …</p></div>
130-
</dd>
131-
<dt id="isotope.port.motor.Motor.__len__"><code class="name flex">
132-
<span>def <span class="ident">__len__</span></span>(<span>self) ‑> int</span>
133-
</code></dt>
134-
<dd>
135-
<p class="inheritance">
136-
<em>Inherited from:</em>
137-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__len__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__len__">__len__</a></code>
138-
</p>
139-
<div class="desc inherited"><p>Get the number of ports …</p></div>
140-
</dd>
141-
</dl>
142119
</dd>
143120
<dt id="isotope.port.motor.MotorPort"><code class="flex name class">
144121
<span>class <span class="ident">MotorPort</span></span>
@@ -669,10 +646,6 @@ <h2 id="returns">Returns</h2>
669646
<ul>
670647
<li>
671648
<h4><code><a title="isotope.port.motor.Motor" href="#isotope.port.motor.Motor">Motor</a></code></h4>
672-
<ul class="">
673-
<li><code><a title="isotope.port.motor.Motor.__getitem__" href="isotope_port.html#isotope.port.motor.Motor.__getitem__">__getitem__</a></code></li>
674-
<li><code><a title="isotope.port.motor.Motor.__len__" href="isotope_port.html#isotope.port.motor.Motor.__len__">__len__</a></code></li>
675-
</ul>
676649
</li>
677650
<li>
678651
<h4><code><a title="isotope.port.motor.MotorPort" href="#isotope.port.motor.MotorPort">MotorPort</a></code></h4>

‎docs/isotope/port/power_output.html‎

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -102,29 +102,6 @@ <h3>Ancestors</h3>
102102
<li><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></li>
103103
<li>typing.Generic</li>
104104
</ul>
105-
<h3>Methods</h3>
106-
<dl>
107-
<dt id="isotope.port.power_output.PowerOutput.__getitem__"><code class="name flex">
108-
<span>def <span class="ident">__getitem__</span></span>(<span>self, key: int) ‑> ~T</span>
109-
</code></dt>
110-
<dd>
111-
<p class="inheritance">
112-
<em>Inherited from:</em>
113-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__getitem__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__getitem__">__getitem__</a></code>
114-
</p>
115-
<div class="desc inherited"><p>Get the specific IsotopePort object by index …</p></div>
116-
</dd>
117-
<dt id="isotope.port.power_output.PowerOutput.__len__"><code class="name flex">
118-
<span>def <span class="ident">__len__</span></span>(<span>self) ‑> int</span>
119-
</code></dt>
120-
<dd>
121-
<p class="inheritance">
122-
<em>Inherited from:</em>
123-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__len__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__len__">__len__</a></code>
124-
</p>
125-
<div class="desc inherited"><p>Get the number of ports …</p></div>
126-
</dd>
127-
</dl>
128105
</dd>
129106
<dt id="isotope.port.power_output.PowerOutputPort"><code class="flex name class">
130107
<span>class <span class="ident">PowerOutputPort</span></span>
@@ -413,10 +390,6 @@ <h2 id="returns">Returns</h2>
413390
<ul>
414391
<li>
415392
<h4><code><a title="isotope.port.power_output.PowerOutput" href="#isotope.port.power_output.PowerOutput">PowerOutput</a></code></h4>
416-
<ul class="">
417-
<li><code><a title="isotope.port.power_output.PowerOutput.__getitem__" href="isotope_port.html#isotope.port.power_output.PowerOutput.__getitem__">__getitem__</a></code></li>
418-
<li><code><a title="isotope.port.power_output.PowerOutput.__len__" href="isotope_port.html#isotope.port.power_output.PowerOutput.__len__">__len__</a></code></li>
419-
</ul>
420393
</li>
421394
<li>
422395
<h4><code><a title="isotope.port.power_output.PowerOutputPort" href="#isotope.port.power_output.PowerOutputPort">PowerOutputPort</a></code></h4>

‎docs/isotope/port/pwm_output.html‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -145,26 +145,6 @@ <h3>Ancestors</h3>
145145
</ul>
146146
<h3>Methods</h3>
147147
<dl>
148-
<dt id="isotope.port.pwm_output.PWMOutput.__getitem__"><code class="name flex">
149-
<span>def <span class="ident">__getitem__</span></span>(<span>self, key: int) ‑> ~T</span>
150-
</code></dt>
151-
<dd>
152-
<p class="inheritance">
153-
<em>Inherited from:</em>
154-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__getitem__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__getitem__">__getitem__</a></code>
155-
</p>
156-
<div class="desc inherited"><p>Get the specific IsotopePort object by index …</p></div>
157-
</dd>
158-
<dt id="isotope.port.pwm_output.PWMOutput.__len__"><code class="name flex">
159-
<span>def <span class="ident">__len__</span></span>(<span>self) ‑> int</span>
160-
</code></dt>
161-
<dd>
162-
<p class="inheritance">
163-
<em>Inherited from:</em>
164-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__len__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__len__">__len__</a></code>
165-
</p>
166-
<div class="desc inherited"><p>Get the number of ports …</p></div>
167-
</dd>
168148
<dt id="isotope.port.pwm_output.PWMOutput.disable"><code class="name flex">
169149
<span>def <span class="ident">disable</span></span>(<span>self) ‑> bool</span>
170150
</code></dt>
@@ -389,8 +369,6 @@ <h2 id="raises">Raises</h2>
389369
<li>
390370
<h4><code><a title="isotope.port.pwm_output.PWMOutput" href="#isotope.port.pwm_output.PWMOutput">PWMOutput</a></code></h4>
391371
<ul class="">
392-
<li><code><a title="isotope.port.pwm_output.PWMOutput.__getitem__" href="isotope_port.html#isotope.port.pwm_output.PWMOutput.__getitem__">__getitem__</a></code></li>
393-
<li><code><a title="isotope.port.pwm_output.PWMOutput.__len__" href="isotope_port.html#isotope.port.pwm_output.PWMOutput.__len__">__len__</a></code></li>
394372
<li><code><a title="isotope.port.pwm_output.PWMOutput.disable" href="#isotope.port.pwm_output.PWMOutput.disable">disable</a></code></li>
395373
<li><code><a title="isotope.port.pwm_output.PWMOutput.enable" href="#isotope.port.pwm_output.PWMOutput.enable">enable</a></code></li>
396374
<li><code><a title="isotope.port.pwm_output.PWMOutput.is_enabled" href="#isotope.port.pwm_output.PWMOutput.is_enabled">is_enabled</a></code></li>

‎docs/isotope/port/temp_input.html‎

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -97,29 +97,6 @@ <h3>Ancestors</h3>
9797
<li><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></li>
9898
<li>typing.Generic</li>
9999
</ul>
100-
<h3>Methods</h3>
101-
<dl>
102-
<dt id="isotope.port.temp_input.TempInput.__getitem__"><code class="name flex">
103-
<span>def <span class="ident">__getitem__</span></span>(<span>self, key: int) ‑> ~T</span>
104-
</code></dt>
105-
<dd>
106-
<p class="inheritance">
107-
<em>Inherited from:</em>
108-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__getitem__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__getitem__">__getitem__</a></code>
109-
</p>
110-
<div class="desc inherited"><p>Get the specific IsotopePort object by index …</p></div>
111-
</dd>
112-
<dt id="isotope.port.temp_input.TempInput.__len__"><code class="name flex">
113-
<span>def <span class="ident">__len__</span></span>(<span>self) ‑> int</span>
114-
</code></dt>
115-
<dd>
116-
<p class="inheritance">
117-
<em>Inherited from:</em>
118-
<code><a title="isotope.port.isotope_port.IsotopePortContainer" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer">IsotopePortContainer</a></code>.<code><a title="isotope.port.isotope_port.IsotopePortContainer.__len__" href="isotope_port.html#isotope.port.isotope_port.IsotopePortContainer.__len__">__len__</a></code>
119-
</p>
120-
<div class="desc inherited"><p>Get the number of ports …</p></div>
121-
</dd>
122-
</dl>
123100
</dd>
124101
<dt id="isotope.port.temp_input.TempInputPort"><code class="flex name class">
125102
<span>class <span class="ident">TempInputPort</span></span>
@@ -271,10 +248,6 @@ <h2 id="returns">Returns</h2>
271248
<ul>
272249
<li>
273250
<h4><code><a title="isotope.port.temp_input.TempInput" href="#isotope.port.temp_input.TempInput">TempInput</a></code></h4>
274-
<ul class="">
275-
<li><code><a title="isotope.port.temp_input.TempInput.__getitem__" href="isotope_port.html#isotope.port.temp_input.TempInput.__getitem__">__getitem__</a></code></li>
276-
<li><code><a title="isotope.port.temp_input.TempInput.__len__" href="isotope_port.html#isotope.port.temp_input.TempInput.__len__">__len__</a></code></li>
277-
</ul>
278251
</li>
279252
<li>
280253
<h4><code><a title="isotope.port.temp_input.TempInputPort" href="#isotope.port.temp_input.TempInputPort">TempInputPort</a></code></h4>

‎python_lib/isotope/isotope/port/isotope_port.py‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,6 @@
2828
import logging
2929

3030

31-
__pdoc__ = {}
32-
__pdoc__['IsotopePortContainer.__getitem__'] = True
33-
__pdoc__['IsotopePortContainer.__len__'] = True
34-
35-
3631
class PortException(Exception):
3732
"""General exception class for the PortController class.
3833
"""

0 commit comments

Comments
 (0)