Skip to content

Commit c367a5a

Browse files
authored
[py] docs: updated api docs (#10622)
1 parent 3d620e3 commit c367a5a

File tree

33 files changed

+878
-3
lines changed

33 files changed

+878
-3
lines changed

‎.gitignore

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,10 @@ py/selenium/webdriver/firefox/amd64/
6767
py/selenium/webdriver/firefox/webdriver.xpi
6868
py/selenium/webdriver/firefox/webdriver_prefs.json
6969
py/selenium/webdriver/firefox/x86/
70-
py/selenium/webdriver/remote/findElements.js
71-
py/selenium/webdriver/remote/getAttribute.js
72-
py/selenium/webdriver/remote/isDisplayed.js
70+
# Removed these files from gitignore due to documentation
71+
# py/selenium/webdriver/remote/findElements.js
72+
# py/selenium/webdriver/remote/getAttribute.js
73+
# py/selenium/webdriver/remote/isDisplayed.js
7374
py/docs/build/
7475
py/build/
7576
py/LICENSE

‎py/docs/source/api.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,21 @@ Webdriver.common
3030
selenium.webdriver.common.proxy
3131
selenium.webdriver.common.utils
3232
selenium.webdriver.common.service
33+
selenium.webdriver.common.options
34+
selenium.webdriver.common.timeouts
35+
selenium.webdriver.common.window
36+
selenium.webdriver.common.actions.action_builder
37+
selenium.webdriver.common.actions.input_device
38+
selenium.webdriver.common.actions.interaction
39+
selenium.webdriver.common.actions.key_actions
40+
selenium.webdriver.common.actions.key_input
41+
selenium.webdriver.common.actions.mouse_button
42+
selenium.webdriver.common.actions.pointer_input
43+
selenium.webdriver.common.actions.pointer_actions
44+
selenium.webdriver.common.actions.wheel_input
45+
selenium.webdriver.common.actions.wheel_actions
3346
selenium.webdriver.common.html5.application_cache
47+
selenium.webdriver.common.virtual_authenticator
3448

3549
Webdriver.support
3650
-----------------
@@ -43,6 +57,7 @@ Webdriver.support
4357
selenium.webdriver.support.color
4458
selenium.webdriver.support.event_firing_webdriver
4559
selenium.webdriver.support.expected_conditions
60+
selenium.webdriver.support.relative_locator
4661
selenium.webdriver.support.select
4762
selenium.webdriver.support.wait
4863

@@ -66,6 +81,7 @@ Webdriver.chromium
6681

6782
selenium.webdriver.chromium.options
6883
selenium.webdriver.chromium.service
84+
selenium.webdriver.chromium.remote_connection
6985
selenium.webdriver.chromium.webdriver
7086

7187
Webdriver.edge
@@ -87,10 +103,12 @@ Webdriver.firefox
87103
:toctree: webdriver_firefox
88104

89105
selenium.webdriver.firefox.extension_connection
106+
selenium.webdriver.firefox.remote_connection
90107
selenium.webdriver.firefox.firefox_binary
91108
selenium.webdriver.firefox.options
92109
selenium.webdriver.firefox.firefox_profile
93110
selenium.webdriver.firefox.webdriver
111+
selenium.webdriver.firefox.service
94112

95113
Webdriver.ie
96114
------------
@@ -99,6 +117,8 @@ Webdriver.ie
99117
.. autosummary::
100118
:toctree: webdriver_ie
101119

120+
selenium.webdriver.ie.service
121+
selenium.webdriver.ie.options
102122
selenium.webdriver.ie.webdriver
103123

104124
Webdriver.opera
@@ -109,6 +129,7 @@ Webdriver.opera
109129
:toctree: webdriver_opera
110130

111131
selenium.webdriver.opera.webdriver
132+
selenium.webdriver.opera.options
112133

113134
Webdriver.remote
114135
----------------
@@ -118,13 +139,17 @@ Webdriver.remote
118139
:toctree: webdriver_remote
119140

120141
selenium.webdriver.remote.command
142+
selenium.webdriver.remote.bidi_connection
121143
selenium.webdriver.remote.errorhandler
122144
selenium.webdriver.remote.mobile
123145
selenium.webdriver.remote.remote_connection
124146
selenium.webdriver.remote.shadowroot
125147
selenium.webdriver.remote.utils
126148
selenium.webdriver.remote.webdriver
127149
selenium.webdriver.remote.webelement
150+
selenium.webdriver.remote.file_detector
151+
selenium.webdriver.remote.script_key
152+
selenium.webdriver.remote.switch_to
128153

129154
Webdriver.safari
130155
----------------
@@ -133,6 +158,9 @@ Webdriver.safari
133158
.. autosummary::
134159
:toctree: webdriver_safari
135160

161+
selenium.webdriver.safari.options
162+
selenium.webdriver.safari.permissions
163+
selenium.webdriver.safari.remote_connection
136164
selenium.webdriver.safari.service
137165
selenium.webdriver.safari.webdriver
138166

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
selenium.webdriver.common.actions.action\_builder
2+
=================================================
3+
4+
.. automodule:: selenium.webdriver.common.actions.action_builder
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
ActionBuilder
21+
22+
23+
24+
25+
26+
27+
28+
29+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
selenium.webdriver.common.actions.input\_device
2+
===============================================
3+
4+
.. automodule:: selenium.webdriver.common.actions.input_device
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
InputDevice
21+
22+
23+
24+
25+
26+
27+
28+
29+
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
selenium.webdriver.common.actions.interaction
2+
=============================================
3+
4+
.. automodule:: selenium.webdriver.common.actions.interaction
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
Interaction
21+
Pause
22+
23+
24+
25+
26+
27+
28+
29+
30+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
selenium.webdriver.common.actions.key\_actions
2+
==============================================
3+
4+
.. automodule:: selenium.webdriver.common.actions.key_actions
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
KeyActions
21+
22+
23+
24+
25+
26+
27+
28+
29+
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
selenium.webdriver.common.actions.key\_input
2+
============================================
3+
4+
.. automodule:: selenium.webdriver.common.actions.key_input
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
KeyInput
21+
TypingInteraction
22+
23+
24+
25+
26+
27+
28+
29+
30+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
selenium.webdriver.common.actions.mouse\_button
2+
===============================================
3+
4+
.. automodule:: selenium.webdriver.common.actions.mouse_button
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
MouseButton
21+
22+
23+
24+
25+
26+
27+
28+
29+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
selenium.webdriver.common.actions.pointer\_actions
2+
==================================================
3+
4+
.. automodule:: selenium.webdriver.common.actions.pointer_actions
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
PointerActions
21+
22+
23+
24+
25+
26+
27+
28+
29+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
selenium.webdriver.common.actions.pointer\_input
2+
================================================
3+
4+
.. automodule:: selenium.webdriver.common.actions.pointer_input
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
PointerInput
21+
22+
23+
24+
25+
26+
27+
28+
29+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
selenium.webdriver.common.actions.wheel\_actions
2+
================================================
3+
4+
.. automodule:: selenium.webdriver.common.actions.wheel_actions
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
WheelActions
21+
22+
23+
24+
25+
26+
27+
28+
29+

0 commit comments

Comments
 (0)