Skip to content

Commit

Permalink
[py] docs: updated api docs (SeleniumHQ#10622)
Browse files Browse the repository at this point in the history
  • Loading branch information
SinghHrmn committed May 10, 2022
1 parent 3d620e3 commit c367a5a
Show file tree
Hide file tree
Showing 33 changed files with 878 additions and 3 deletions.
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,10 @@ py/selenium/webdriver/firefox/amd64/
py/selenium/webdriver/firefox/webdriver.xpi
py/selenium/webdriver/firefox/webdriver_prefs.json
py/selenium/webdriver/firefox/x86/
py/selenium/webdriver/remote/findElements.js
py/selenium/webdriver/remote/getAttribute.js
py/selenium/webdriver/remote/isDisplayed.js
# Removed these files from gitignore due to documentation
# py/selenium/webdriver/remote/findElements.js
# py/selenium/webdriver/remote/getAttribute.js
# py/selenium/webdriver/remote/isDisplayed.js
py/docs/build/
py/build/
py/LICENSE
Expand Down
28 changes: 28 additions & 0 deletions py/docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,21 @@ Webdriver.common
selenium.webdriver.common.proxy
selenium.webdriver.common.utils
selenium.webdriver.common.service
selenium.webdriver.common.options
selenium.webdriver.common.timeouts
selenium.webdriver.common.window
selenium.webdriver.common.actions.action_builder
selenium.webdriver.common.actions.input_device
selenium.webdriver.common.actions.interaction
selenium.webdriver.common.actions.key_actions
selenium.webdriver.common.actions.key_input
selenium.webdriver.common.actions.mouse_button
selenium.webdriver.common.actions.pointer_input
selenium.webdriver.common.actions.pointer_actions
selenium.webdriver.common.actions.wheel_input
selenium.webdriver.common.actions.wheel_actions
selenium.webdriver.common.html5.application_cache
selenium.webdriver.common.virtual_authenticator

Webdriver.support
-----------------
Expand All @@ -43,6 +57,7 @@ Webdriver.support
selenium.webdriver.support.color
selenium.webdriver.support.event_firing_webdriver
selenium.webdriver.support.expected_conditions
selenium.webdriver.support.relative_locator
selenium.webdriver.support.select
selenium.webdriver.support.wait

Expand All @@ -66,6 +81,7 @@ Webdriver.chromium

selenium.webdriver.chromium.options
selenium.webdriver.chromium.service
selenium.webdriver.chromium.remote_connection
selenium.webdriver.chromium.webdriver

Webdriver.edge
Expand All @@ -87,10 +103,12 @@ Webdriver.firefox
:toctree: webdriver_firefox

selenium.webdriver.firefox.extension_connection
selenium.webdriver.firefox.remote_connection
selenium.webdriver.firefox.firefox_binary
selenium.webdriver.firefox.options
selenium.webdriver.firefox.firefox_profile
selenium.webdriver.firefox.webdriver
selenium.webdriver.firefox.service

Webdriver.ie
------------
Expand All @@ -99,6 +117,8 @@ Webdriver.ie
.. autosummary::
:toctree: webdriver_ie

selenium.webdriver.ie.service
selenium.webdriver.ie.options
selenium.webdriver.ie.webdriver

Webdriver.opera
Expand All @@ -109,6 +129,7 @@ Webdriver.opera
:toctree: webdriver_opera

selenium.webdriver.opera.webdriver
selenium.webdriver.opera.options

Webdriver.remote
----------------
Expand All @@ -118,13 +139,17 @@ Webdriver.remote
:toctree: webdriver_remote

selenium.webdriver.remote.command
selenium.webdriver.remote.bidi_connection
selenium.webdriver.remote.errorhandler
selenium.webdriver.remote.mobile
selenium.webdriver.remote.remote_connection
selenium.webdriver.remote.shadowroot
selenium.webdriver.remote.utils
selenium.webdriver.remote.webdriver
selenium.webdriver.remote.webelement
selenium.webdriver.remote.file_detector
selenium.webdriver.remote.script_key
selenium.webdriver.remote.switch_to

Webdriver.safari
----------------
Expand All @@ -133,6 +158,9 @@ Webdriver.safari
.. autosummary::
:toctree: webdriver_safari

selenium.webdriver.safari.options
selenium.webdriver.safari.permissions
selenium.webdriver.safari.remote_connection
selenium.webdriver.safari.service
selenium.webdriver.safari.webdriver

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
selenium.webdriver.common.actions.action\_builder
=================================================

.. automodule:: selenium.webdriver.common.actions.action_builder











.. rubric:: Classes

.. autosummary::

ActionBuilder









Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
selenium.webdriver.common.actions.input\_device
===============================================

.. automodule:: selenium.webdriver.common.actions.input_device











.. rubric:: Classes

.. autosummary::

InputDevice









Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
selenium.webdriver.common.actions.interaction
=============================================

.. automodule:: selenium.webdriver.common.actions.interaction











.. rubric:: Classes

.. autosummary::

Interaction
Pause









Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
selenium.webdriver.common.actions.key\_actions
==============================================

.. automodule:: selenium.webdriver.common.actions.key_actions











.. rubric:: Classes

.. autosummary::

KeyActions









Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
selenium.webdriver.common.actions.key\_input
============================================

.. automodule:: selenium.webdriver.common.actions.key_input











.. rubric:: Classes

.. autosummary::

KeyInput
TypingInteraction









Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
selenium.webdriver.common.actions.mouse\_button
===============================================

.. automodule:: selenium.webdriver.common.actions.mouse_button











.. rubric:: Classes

.. autosummary::

MouseButton









Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
selenium.webdriver.common.actions.pointer\_actions
==================================================

.. automodule:: selenium.webdriver.common.actions.pointer_actions











.. rubric:: Classes

.. autosummary::

PointerActions









Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
selenium.webdriver.common.actions.pointer\_input
================================================

.. automodule:: selenium.webdriver.common.actions.pointer_input











.. rubric:: Classes

.. autosummary::

PointerInput









Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
selenium.webdriver.common.actions.wheel\_actions
================================================

.. automodule:: selenium.webdriver.common.actions.wheel_actions











.. rubric:: Classes

.. autosummary::

WheelActions









Loading

0 comments on commit c367a5a

Please sign in to comment.