[py] Add missing modules to Python API docs #15624
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
User description
🔗 Related Issues
Fixes: #15623
💥 What does this PR do?
This PR updates the Python API documentation to include modules that were missing.
In
py/docs/source/api.rst
, all the Python modules in the selenium package are listed. Sphinx uses this file to generate the docs from source code docstrings. This file needs to be updated anytime a new module is added or removed from the Python package.It hasn't been updated in a while, and the following modules were missing:
I also rearranged some of the modules so they are in correct alphabetical order.
For future reference, here is the code I used to find all the modules in the package (run this from the
./py
directory:🔄 Types of changes
PR Type
Documentation, Bug fix
Description
Added missing Python modules to API documentation.
Rearranged modules in alphabetical order for consistency.
Corrected placement of
Webdriver.wpewebkit
section in documentation.Changes walkthrough 📝
api.rst
Update and organize Python API documentation
py/docs/source/api.rst
Webdriver.wpewebkit
section.