Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[py] Update Documentation api.rst File List #14172

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 36 additions & 14 deletions py/docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,32 @@ Webdriver.common
selenium.webdriver.common.alert
selenium.webdriver.common.by
selenium.webdriver.common.desired_capabilities
selenium.webdriver.common.driver_finder
selenium.webdriver.common.keys
selenium.webdriver.common.log
selenium.webdriver.common.options
selenium.webdriver.common.print_page_options
selenium.webdriver.common.proxy
selenium.webdriver.common.utils
selenium.webdriver.common.selenium_manager
selenium.webdriver.common.service
selenium.webdriver.common.options
selenium.webdriver.common.timeouts
selenium.webdriver.common.utils
selenium.webdriver.common.virtual_authenticator
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.pointer_input
selenium.webdriver.common.actions.wheel_actions
selenium.webdriver.common.virtual_authenticator
selenium.webdriver.common.actions.wheel_input
selenium.webdriver.common.bidi.cdp
selenium.webdriver.common.bidi.console
selenium.webdriver.common.bidi.script
selenium.webdriver.common.bidi.session

Webdriver.support
-----------------
Expand All @@ -55,9 +61,11 @@ Webdriver.support
selenium.webdriver.support.abstract_event_listener
selenium.webdriver.support.color
selenium.webdriver.support.event_firing_webdriver
selenium.webdriver.support.events
selenium.webdriver.support.expected_conditions
selenium.webdriver.support.relative_locator
selenium.webdriver.support.select
selenium.webdriver.support.ui
selenium.webdriver.support.wait

Webdriver.chrome
Expand All @@ -68,6 +76,7 @@ Webdriver.chrome
:toctree: webdriver_chrome

selenium.webdriver.chrome.options
selenium.webdriver.chrome.remote_connection
selenium.webdriver.chrome.service
selenium.webdriver.chrome.webdriver

Expand All @@ -79,8 +88,8 @@ Webdriver.chromium
:toctree: webdriver_chromium

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

Webdriver.edge
Expand All @@ -91,6 +100,7 @@ Webdriver.edge
:toctree: webdriver_edge

selenium.webdriver.edge.options
selenium.webdriver.edge.remote_connection
selenium.webdriver.edge.service
selenium.webdriver.edge.webdriver

Expand All @@ -101,13 +111,12 @@ Webdriver.firefox
.. autosummary::
: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.options
selenium.webdriver.firefox.remote_connection
selenium.webdriver.firefox.service
selenium.webdriver.firefox.webdriver

Webdriver.ie
------------
Expand All @@ -127,18 +136,19 @@ Webdriver.remote
.. autosummary::
:toctree: webdriver_remote

selenium.webdriver.remote.command
selenium.webdriver.remote.bidi_connection
selenium.webdriver.remote.command
selenium.webdriver.remote.errorhandler
selenium.webdriver.remote.file_detector
selenium.webdriver.remote.mobile
selenium.webdriver.remote.remote_connection
selenium.webdriver.remote.script_key
selenium.webdriver.remote.shadowroot
selenium.webdriver.remote.switch_to
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
selenium.webdriver.remote.websocket_connection

Webdriver.safari
----------------
Expand All @@ -148,10 +158,22 @@ Webdriver.safari
:toctree: webdriver_safari

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

Webdriver.wpewebkit
-------------------

.. currentmodule:: selenium.webdriver.wpewebkit
.. autosummary::
:toctree: webdriver_wpewebkit

selenium.webdriver.wpewebkit.options
selenium.webdriver.wpewebkit.service
selenium.webdriver.wpewebkit.webdriver

Webdriver.webkitgtk
-------------------

Expand Down
30 changes: 15 additions & 15 deletions py/docs/source/common/selenium.common.exceptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@

.. automodule:: selenium.common.exceptions


























.. rubric:: Exceptions

.. autosummary::

ElementClickInterceptedException
ElementNotInteractableException
ElementNotSelectableException
Expand All @@ -40,12 +40,12 @@
NoAlertPresentException
NoSuchAttributeException
NoSuchCookieException
NoSuchDriverException
NoSuchElementException
NoSuchFrameException
NoSuchShadowRootException
NoSuchWindowException
ScreenshotException
SeleniumManagerException
SessionNotCreatedException
StaleElementReferenceException
TimeoutException
Expand All @@ -54,8 +54,8 @@
UnexpectedTagNameException
UnknownMethodException
WebDriverException





54 changes: 54 additions & 0 deletions py/docs/source/webdriver/selenium.webdriver.common.bidi.cdp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
selenium.webdriver.common.bidi.cdp
==================================

.. automodule:: selenium.webdriver.common.bidi.cdp







.. rubric:: Functions

.. autosummary::

connect_cdp
connection_context
get_connection_context
get_session_context
import_devtools
open_cdp
session_context
set_global_connection
set_global_session





.. rubric:: Classes

.. autosummary::

CdpBase
CdpConnection
CdpSession
CmEventProxy





.. rubric:: Exceptions

.. autosummary::

BrowserError
CdpConnectionClosed
InternalError





Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
selenium.webdriver.common.bidi.console
======================================

.. automodule:: selenium.webdriver.common.bidi.console











.. rubric:: Classes

.. autosummary::

Console









32 changes: 32 additions & 0 deletions py/docs/source/webdriver/selenium.webdriver.common.bidi.script.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
selenium.webdriver.common.bidi.script
=====================================

.. automodule:: selenium.webdriver.common.bidi.script











.. rubric:: Classes

.. autosummary::

ConsoleLogEntry
JavaScriptLogEntry
LogEntryAdded
Script









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

.. automodule:: selenium.webdriver.common.bidi.session







.. rubric:: Functions

.. autosummary::

session_subscribe
session_unsubscribe













Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
selenium.webdriver.common.driver\_finder
========================================

.. automodule:: selenium.webdriver.common.driver_finder











.. rubric:: Classes

.. autosummary::

DriverFinder









Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

ArgOptions
BaseOptions
PageLoadStrategy



Expand Down
Loading