Skip to content

Commit ee7a97b

Browse files
ki4070maki4070ma
authored
docs: Added api document for Appium-Python-Client (#1)
* Copied from ki4070ma/python-client-sphinx * Updated docs along to the latest lib * Update README
1 parent 79cd6d2 commit ee7a97b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+26563
-1
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea/

‎README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,16 @@
1-
python-client-sphinx
1+
# Documents
2+
https://appium.github.io/python-client-sphinx/
3+
4+
# How to update documents
5+
6+
```bash
7+
git clone [email protected]:appium/python-client.git
8+
git clone [email protected]:appium/python-client-sphinx.git
9+
10+
cd /path/to/python-client/docs
11+
bash generate.sh
12+
13+
cd /path/to/python-client-sphinx
14+
rm -r docs
15+
cp -r /path/to/python-client/docs/_build/html ./docs
16+
```

‎docs/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 525d40e4fdf62da05630805ae8caf657
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/.nojekyll

Whitespace-only changes.

‎docs/_sources/index.rst.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. Appium python client documentation master file, created by
2+
sphinx-quickstart on Mon May 4 19:23:08 2020.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to Appium python client's documentation!
7+
================================================
8+
9+
.. toctree::
10+
:maxdepth: 4
11+
:caption: Contents:
12+
13+
webdriver
14+
15+
16+
Indices and tables
17+
==================
18+
19+
* :ref:`genindex`
20+
* :ref:`modindex`
21+
* :ref:`search`

‎docs/_sources/webdriver.common.rst.txt

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
webdriver.common package
2+
========================
3+
4+
Submodules
5+
----------
6+
7+
webdriver.common.mobileby module
8+
--------------------------------
9+
10+
.. automodule:: webdriver.common.mobileby
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
webdriver.common.multi\_action module
16+
-------------------------------------
17+
18+
.. automodule:: webdriver.common.multi_action
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
webdriver.common.touch\_action module
24+
-------------------------------------
25+
26+
.. automodule:: webdriver.common.touch_action
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
Module contents
33+
---------------
34+
35+
.. automodule:: webdriver.common
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:

‎docs/_sources/webdriver.extensions.android.rst.txt

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
webdriver.extensions.android package
2+
====================================
3+
4+
Submodules
5+
----------
6+
7+
webdriver.extensions.android.activities module
8+
----------------------------------------------
9+
10+
.. automodule:: webdriver.extensions.android.activities
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
webdriver.extensions.android.common module
16+
------------------------------------------
17+
18+
.. automodule:: webdriver.extensions.android.common
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
webdriver.extensions.android.display module
24+
-------------------------------------------
25+
26+
.. automodule:: webdriver.extensions.android.display
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
webdriver.extensions.android.gsm module
32+
---------------------------------------
33+
34+
.. automodule:: webdriver.extensions.android.gsm
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
webdriver.extensions.android.nativekey module
40+
---------------------------------------------
41+
42+
.. automodule:: webdriver.extensions.android.nativekey
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
webdriver.extensions.android.network module
48+
-------------------------------------------
49+
50+
.. automodule:: webdriver.extensions.android.network
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
webdriver.extensions.android.performance module
56+
-----------------------------------------------
57+
58+
.. automodule:: webdriver.extensions.android.performance
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
webdriver.extensions.android.power module
64+
-----------------------------------------
65+
66+
.. automodule:: webdriver.extensions.android.power
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
webdriver.extensions.android.sms module
72+
---------------------------------------
73+
74+
.. automodule:: webdriver.extensions.android.sms
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
webdriver.extensions.android.system\_bars module
80+
------------------------------------------------
81+
82+
.. automodule:: webdriver.extensions.android.system_bars
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
88+
Module contents
89+
---------------
90+
91+
.. automodule:: webdriver.extensions.android
92+
:members:
93+
:undoc-members:
94+
:show-inheritance:

‎docs/_sources/webdriver.extensions.rst.txt

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
webdriver.extensions package
2+
============================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
webdriver.extensions.android
11+
webdriver.extensions.search_context
12+
13+
Submodules
14+
----------
15+
16+
webdriver.extensions.action\_helpers module
17+
-------------------------------------------
18+
19+
.. automodule:: webdriver.extensions.action_helpers
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
webdriver.extensions.applications module
25+
----------------------------------------
26+
27+
.. automodule:: webdriver.extensions.applications
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
webdriver.extensions.clipboard module
33+
-------------------------------------
34+
35+
.. automodule:: webdriver.extensions.clipboard
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
webdriver.extensions.context module
41+
-----------------------------------
42+
43+
.. automodule:: webdriver.extensions.context
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:
47+
48+
webdriver.extensions.device\_time module
49+
----------------------------------------
50+
51+
.. automodule:: webdriver.extensions.device_time
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:
55+
56+
webdriver.extensions.execute\_driver module
57+
-------------------------------------------
58+
59+
.. automodule:: webdriver.extensions.execute_driver
60+
:members:
61+
:undoc-members:
62+
:show-inheritance:
63+
64+
webdriver.extensions.execute\_mobile\_command module
65+
----------------------------------------------------
66+
67+
.. automodule:: webdriver.extensions.execute_mobile_command
68+
:members:
69+
:undoc-members:
70+
:show-inheritance:
71+
72+
webdriver.extensions.hw\_actions module
73+
---------------------------------------
74+
75+
.. automodule:: webdriver.extensions.hw_actions
76+
:members:
77+
:undoc-members:
78+
:show-inheritance:
79+
80+
webdriver.extensions.images\_comparison module
81+
----------------------------------------------
82+
83+
.. automodule:: webdriver.extensions.images_comparison
84+
:members:
85+
:undoc-members:
86+
:show-inheritance:
87+
88+
webdriver.extensions.ime module
89+
-------------------------------
90+
91+
.. automodule:: webdriver.extensions.ime
92+
:members:
93+
:undoc-members:
94+
:show-inheritance:
95+
96+
webdriver.extensions.keyboard module
97+
------------------------------------
98+
99+
.. automodule:: webdriver.extensions.keyboard
100+
:members:
101+
:undoc-members:
102+
:show-inheritance:
103+
104+
webdriver.extensions.location module
105+
------------------------------------
106+
107+
.. automodule:: webdriver.extensions.location
108+
:members:
109+
:undoc-members:
110+
:show-inheritance:
111+
112+
webdriver.extensions.log\_event module
113+
--------------------------------------
114+
115+
.. automodule:: webdriver.extensions.log_event
116+
:members:
117+
:undoc-members:
118+
:show-inheritance:
119+
120+
webdriver.extensions.remote\_fs module
121+
--------------------------------------
122+
123+
.. automodule:: webdriver.extensions.remote_fs
124+
:members:
125+
:undoc-members:
126+
:show-inheritance:
127+
128+
webdriver.extensions.screen\_record module
129+
------------------------------------------
130+
131+
.. automodule:: webdriver.extensions.screen_record
132+
:members:
133+
:undoc-members:
134+
:show-inheritance:
135+
136+
webdriver.extensions.session module
137+
-----------------------------------
138+
139+
.. automodule:: webdriver.extensions.session
140+
:members:
141+
:undoc-members:
142+
:show-inheritance:
143+
144+
webdriver.extensions.settings module
145+
------------------------------------
146+
147+
.. automodule:: webdriver.extensions.settings
148+
:members:
149+
:undoc-members:
150+
:show-inheritance:
151+
152+
153+
Module contents
154+
---------------
155+
156+
.. automodule:: webdriver.extensions
157+
:members:
158+
:undoc-members:
159+
:show-inheritance:

0 commit comments

Comments
 (0)