Skip to content

Commit a93e453

Browse files
dtmilanodtmilano
committed
Update docs
1 parent 3939c4f commit a93e453

File tree

10 files changed

+61
-22
lines changed

10 files changed

+61
-22
lines changed

‎docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: b6a75f9db3df08c63e58ace88b81bc02
3+
config: 5a27d16a9ecdea664dc9897c0ba99fac
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/.doctrees/environment.pickle‎

1.96 KB
Binary file not shown.

‎docs/.doctrees/index.doctree‎

8.53 KB
Binary file not shown.

‎docs/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '22.2.0',
3+
VERSION: '22.5.0',
44
LANGUAGE: 'en',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/genindex.html‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Index &#8212; AndroidViewClient/culebra 22.2.0 documentation</title>
8+
<title>Index &#8212; AndroidViewClient/culebra 22.5.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
@@ -29,7 +29,7 @@ <h3>Navigation</h3>
2929
<li class="right" >
3030
<a href="py-modindex.html" title="Python Module Index"
3131
>modules</a> |</li>
32-
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.2.0 documentation</a> &#187;</li>
32+
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.5.0 documentation</a> &#187;</li>
3333
<li class="nav-item nav-item-this"><a href="">Index</a></li>
3434
</ul>
3535
</div>
@@ -297,8 +297,14 @@ <h2 id="G">G</h2>
297297
<td style="width: 33%; vertical-align: top;"><ul>
298298
<li><a href="index.html#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_child_count">get_child_count() (com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject method)</a>
299299
</li>
300-
<li><a href="index.html#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject2.get_content_description">get_content_description() (com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject2 method)</a>
300+
<li><a href="index.html#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_class_name">get_class_name() (com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject method)</a>
301301
</li>
302+
<li><a href="index.html#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_content_description">get_content_description() (com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject method)</a>
303+
304+
<ul>
305+
<li><a href="index.html#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject2.get_content_description">(com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject2 method)</a>
306+
</li>
307+
</ul></li>
302308
<li><a href="index.html#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject2.get_text">get_text() (com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject2 method)</a>
303309
</li>
304310
<li><a href="index.html#com.dtmilano.android.viewclient.View.getBounds">getBounds() (com.dtmilano.android.viewclient.View method)</a>
@@ -326,11 +332,11 @@ <h2 id="G">G</h2>
326332
<li><a href="index.html#com.dtmilano.android.viewclient.View.getParent">getParent() (com.dtmilano.android.viewclient.View method)</a>
327333
</li>
328334
<li><a href="index.html#com.dtmilano.android.adb.adbclient.AdbClient.getPhysicalDisplayInfo">getPhysicalDisplayInfo() (com.dtmilano.android.adb.adbclient.AdbClient method)</a>
329-
</li>
330-
<li><a href="index.html#com.dtmilano.android.viewclient.View.getPositionAndSize">getPositionAndSize() (com.dtmilano.android.viewclient.View method)</a>
331335
</li>
332336
</ul></td>
333337
<td style="width: 33%; vertical-align: top;"><ul>
338+
<li><a href="index.html#com.dtmilano.android.viewclient.View.getPositionAndSize">getPositionAndSize() (com.dtmilano.android.viewclient.View method)</a>
339+
</li>
334340
<li><a href="index.html#com.dtmilano.android.adb.adbclient.AdbClient.getProperty">getProperty() (com.dtmilano.android.adb.adbclient.AdbClient method)</a>
335341
</li>
336342
<li><a href="index.html#com.dtmilano.android.adb.adbclient.AdbClient.getRestrictedScreen">getRestrictedScreen() (com.dtmilano.android.adb.adbclient.AdbClient method)</a>
@@ -816,7 +822,7 @@ <h3>Navigation</h3>
816822
<li class="right" >
817823
<a href="py-modindex.html" title="Python Module Index"
818824
>modules</a> |</li>
819-
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.2.0 documentation</a> &#187;</li>
825+
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.5.0 documentation</a> &#187;</li>
820826
<li class="nav-item nav-item-this"><a href="">Index</a></li>
821827
</ul>
822828
</div>

‎docs/index.html‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
88

9-
<title>Welcome to AndroidViewClient/culebra’s documentation! &#8212; AndroidViewClient/culebra 22.2.0 documentation</title>
9+
<title>Welcome to AndroidViewClient/culebra’s documentation! &#8212; AndroidViewClient/culebra 22.5.0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1212
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
@@ -30,7 +30,7 @@ <h3>Navigation</h3>
3030
<li class="right" >
3131
<a href="py-modindex.html" title="Python Module Index"
3232
>modules</a> |</li>
33-
<li class="nav-item nav-item-0"><a href="#">AndroidViewClient/culebra 22.2.0 documentation</a> &#187;</li>
33+
<li class="nav-item nav-item-0"><a href="#">AndroidViewClient/culebra 22.5.0 documentation</a> &#187;</li>
3434
<li class="nav-item nav-item-this"><a href="">Welcome to AndroidViewClient/culebra’s documentation!</a></li>
3535
</ul>
3636
</div>
@@ -238,8 +238,20 @@ <h1>Welcome to AndroidViewClient/culebra’s documentation!<a class="headerlink"
238238

239239
<dl class="py method">
240240
<dt class="sig sig-object py" id="com.dtmilano.android.adb.adbclient.AdbClient.takeSnapshot">
241-
<span class="sig-name descname"><span class="pre">takeSnapshot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reconnect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.dtmilano.android.adb.adbclient.AdbClient.takeSnapshot" title="Permalink to this definition"></a></dt>
242-
<dd><p>Takes a snapshot of the device and return it as a PIL Image.</p>
241+
<span class="sig-name descname"><span class="pre">takeSnapshot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reconnect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">box</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.dtmilano.android.adb.adbclient.AdbClient.takeSnapshot" title="Permalink to this definition"></a></dt>
242+
<dd><p>Takes a snapshot of the device and return it as a PIL Image.
243+
The snapshot is for the entire screen or can be limited to the box if specified.</p>
244+
<dl class="field-list simple">
245+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
246+
<dd class="field-odd"><ul class="simple">
247+
<li><p><strong>reconnect</strong> – reconnects after taking the screenshot</p></li>
248+
<li><p><strong>box</strong> – box as a tuple indicating (left, top, right, bottom) to crop the entire screen</p></li>
249+
</ul>
250+
</dd>
251+
<dt class="field-even">Returns<span class="colon">:</span></dt>
252+
<dd class="field-even"><p>the image</p>
253+
</dd>
254+
</dl>
243255
</dd></dl>
244256

245257
<dl class="py method">
@@ -681,9 +693,28 @@ <h1>Welcome to AndroidViewClient/culebra’s documentation!<a class="headerlink"
681693
<dl class="py method">
682694
<dt class="sig sig-object py" id="com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_child_count">
683695
<span class="sig-name descname"><span class="pre">get_child_count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">oid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_child_count" title="Permalink to this definition"></a></dt>
684-
<dd><p>:see <a class="reference external" href="https://github.com/dtmilano/CulebraTester2-public/blob/master/openapi.yaml">https://github.com/dtmilano/CulebraTester2-public/blob/master/openapi.yaml</a>
696+
<dd><p>Counts the child views immediately under the present UiObject.
697+
:see <a class="reference external" href="https://github.com/dtmilano/CulebraTester2-public/blob/master/openapi.yaml">https://github.com/dtmilano/CulebraTester2-public/blob/master/openapi.yaml</a>
698+
:param oid: the oid
699+
:return: the child count</p>
700+
</dd></dl>
701+
702+
<dl class="py method">
703+
<dt class="sig sig-object py" id="com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_class_name">
704+
<span class="sig-name descname"><span class="pre">get_class_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">oid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_class_name" title="Permalink to this definition"></a></dt>
705+
<dd><p>Retrieves the className property of the UI element.
706+
:see <a class="reference external" href="https://github.com/dtmilano/CulebraTester2-public/blob/master/openapi.yaml">https://github.com/dtmilano/CulebraTester2-public/blob/master/openapi.yaml</a>
685707
:param oid:
686-
:return:</p>
708+
:return: the class name</p>
709+
</dd></dl>
710+
711+
<dl class="py method">
712+
<dt class="sig sig-object py" id="com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_content_description">
713+
<span class="sig-name descname"><span class="pre">get_content_description</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">oid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_content_description" title="Permalink to this definition"></a></dt>
714+
<dd><p>Reads the content_desc property of the UI element.
715+
:see <a class="reference external" href="https://github.com/dtmilano/CulebraTester2-public/blob/master/openapi.yaml">https://github.com/dtmilano/CulebraTester2-public/blob/master/openapi.yaml</a>
716+
:param oid: the oid
717+
:return: the content description</p>
687718
</dd></dl>
688719

689720
<dl class="py method">
@@ -2243,6 +2274,8 @@ <h3><a href="#">Table of Contents</a></h3>
22432274
<li><a class="reference internal" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.dump"><code class="docutils literal notranslate"><span class="pre">UiAutomatorHelper.UiObject.dump()</span></code></a></li>
22442275
<li><a class="reference internal" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.exists"><code class="docutils literal notranslate"><span class="pre">UiAutomatorHelper.UiObject.exists()</span></code></a></li>
22452276
<li><a class="reference internal" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_child_count"><code class="docutils literal notranslate"><span class="pre">UiAutomatorHelper.UiObject.get_child_count()</span></code></a></li>
2277+
<li><a class="reference internal" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_class_name"><code class="docutils literal notranslate"><span class="pre">UiAutomatorHelper.UiObject.get_class_name()</span></code></a></li>
2278+
<li><a class="reference internal" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.get_content_description"><code class="docutils literal notranslate"><span class="pre">UiAutomatorHelper.UiObject.get_content_description()</span></code></a></li>
22462279
<li><a class="reference internal" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.perform_two_pointer_gesture"><code class="docutils literal notranslate"><span class="pre">UiAutomatorHelper.UiObject.perform_two_pointer_gesture()</span></code></a></li>
22472280
<li><a class="reference internal" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.pinch_in"><code class="docutils literal notranslate"><span class="pre">UiAutomatorHelper.UiObject.pinch_in()</span></code></a></li>
22482281
<li><a class="reference internal" href="#com.dtmilano.android.uiautomator.uiautomatorhelper.UiAutomatorHelper.UiObject.pinch_out"><code class="docutils literal notranslate"><span class="pre">UiAutomatorHelper.UiObject.pinch_out()</span></code></a></li>
@@ -2483,7 +2516,7 @@ <h3>Navigation</h3>
24832516
<li class="right" >
24842517
<a href="py-modindex.html" title="Python Module Index"
24852518
>modules</a> |</li>
2486-
<li class="nav-item nav-item-0"><a href="#">AndroidViewClient/culebra 22.2.0 documentation</a> &#187;</li>
2519+
<li class="nav-item nav-item-0"><a href="#">AndroidViewClient/culebra 22.5.0 documentation</a> &#187;</li>
24872520
<li class="nav-item nav-item-this"><a href="">Welcome to AndroidViewClient/culebra’s documentation!</a></li>
24882521
</ul>
24892522
</div>

‎docs/objects.inv‎

10 Bytes
Binary file not shown.

‎docs/py-modindex.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Python Module Index &#8212; AndroidViewClient/culebra 22.2.0 documentation</title>
8+
<title>Python Module Index &#8212; AndroidViewClient/culebra 22.5.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<li class="right" >
3333
<a href="#" title="Python Module Index"
3434
>modules</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.2.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.5.0 documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
3737
</ul>
3838
</div>
@@ -106,7 +106,7 @@ <h3>Navigation</h3>
106106
<li class="right" >
107107
<a href="#" title="Python Module Index"
108108
>modules</a> |</li>
109-
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.2.0 documentation</a> &#187;</li>
109+
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.5.0 documentation</a> &#187;</li>
110110
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
111111
</ul>
112112
</div>

‎docs/search.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Search &#8212; AndroidViewClient/culebra 22.2.0 documentation</title>
8+
<title>Search &#8212; AndroidViewClient/culebra 22.5.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
@@ -35,7 +35,7 @@ <h3>Navigation</h3>
3535
<li class="right" >
3636
<a href="py-modindex.html" title="Python Module Index"
3737
>modules</a> |</li>
38-
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.2.0 documentation</a> &#187;</li>
38+
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.5.0 documentation</a> &#187;</li>
3939
<li class="nav-item nav-item-this"><a href="">Search</a></li>
4040
</ul>
4141
</div>
@@ -95,7 +95,7 @@ <h3>Navigation</h3>
9595
<li class="right" >
9696
<a href="py-modindex.html" title="Python Module Index"
9797
>modules</a> |</li>
98-
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.2.0 documentation</a> &#187;</li>
98+
<li class="nav-item nav-item-0"><a href="index.html">AndroidViewClient/culebra 22.5.0 documentation</a> &#187;</li>
9999
<li class="nav-item nav-item-this"><a href="">Search</a></li>
100100
</ul>
101101
</div>

‎docs/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)