- 
          
 - 
                Notifications
    
You must be signed in to change notification settings  - Fork 8.6k
 
[py] Fix API doc generation script and include BiDi Emulation docs #16037
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
Conversation
          PR Reviewer Guide 🔍Here are some key observations to aid the review process: 
  | 
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this, I always forget to add an entry for a new module. Can we add this script in format.sh so it runs automatically?
| 
           It actually runs automatically when the docs are generated, so we could just remove   | 
    
User description
💥 What does this PR do?
This PR fixes the
py/generate_api_module_listing.pyscript used in generating the Python API documentation. It was creating duplicate module names in some areas of the table of contents.For example, it was creating an entry for all the
selenium.webdriver.common.actionsmodules under both thewebdriver.common.actionsandwebdriver.commonsections.This PR also includes a newly generated
py/docs/source/api.rstfile that includes the newselenium.webdriver.common.bidi.emulationmodule from #15819🔄 Types of changes
PR Type
Bug fix, Documentation
Description
Fix duplicate module entries in Python API documentation
Include new BiDi Emulation module in documentation
Clean up module listing generation logic
Changes diagram
Changes walkthrough 📝
generate_api_module_listing.py
Fix duplicate module generation logicpy/generate_api_module_listing.py
api.rst
Update API documentation with clean module listingpy/docs/source/api.rst