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

Update documentation for Selenium 4.30.0 (py) #15476

Merged
merged 1 commit into from
Mar 22, 2025

Conversation

selenium-ci
Copy link
Member

@selenium-ci selenium-ci commented Mar 21, 2025

User description

This PR updates the API documentation for py language bindings to version 4.30.0.


PR Type

documentation, enhancement, formatting, dependencies


Description

  • Updated the API documentation for Selenium Python bindings to version 4.30.0.

  • Added multi-language support for Lunr.js, including languages such as Japanese, Turkish, Romanian, Italian, Spanish, French, Portuguese, Hungarian, Finnish, Russian, Dutch, German, Danish, Norwegian, Thai, and Swedish.

  • Enhanced search tools with term highlighting, query handling improvements, and anchored content extraction.

  • Added new JavaScript utilities for Lunr.js, including stemmer support and multi-language configurations.

  • Improved CSS styling for dropdown menus and updated basic styles with visited link styling.

  • Added Modernizr library for feature detection and Material Icons font CSS.

  • Updated HTML structure and styling for documentation pages, improving accessibility and navigation.

  • Cleaned up formatting in multiple documentation files by removing excessive blank lines.

  • Updated copyright years to 2024 across various files.

  • Updated documentation options to reflect version 4.30.0.


Changes walkthrough 📝

Relevant files
Enhancement
26 files
tinyseg.js
Add Japanese text segmentation support for Lunr.js.           

docs/api/py/_static/javascripts/lunr/tinyseg.js

  • Added a new JavaScript file tinyseg.js for Lunr.js.
  • Implements segmentation logic for Japanese text processing.
  • Includes various character type mappings and segmentation rules.
  • +1/-0     
    lunr.tr.js
    Add Turkish language support for Lunr.js.                               

    docs/api/py/_static/javascripts/lunr/lunr.tr.js

  • Added a new JavaScript file lunr.tr.js for Lunr.js.
  • Provides Turkish language support including stemming and stop word
    filtering.
  • Registers Turkish-specific pipeline functions for Lunr.js.
  • +1/-0     
    lunr.ro.js
    Add Romanian language support for Lunr.js.                             

    docs/api/py/_static/javascripts/lunr/lunr.ro.js

  • Added a new JavaScript file lunr.ro.js for Lunr.js.
  • Implements Romanian language support with stemming and stop word
    filtering.
  • Registers Romanian-specific pipeline functions for Lunr.js.
  • +1/-0     
    lunr.it.js
    Add Italian language support for Lunr.js.                               

    docs/api/py/_static/javascripts/lunr/lunr.it.js

  • Added a new JavaScript file lunr.it.js for Lunr.js.
  • Provides Italian language support including stemming and stop word
    filtering.
  • Registers Italian-specific pipeline functions for Lunr.js.
  • +1/-0     
    lunr.es.js
    Add Spanish language support for Lunr.js.                               

    docs/api/py/_static/javascripts/lunr/lunr.es.js

  • Added a new JavaScript file lunr.es.js for Lunr.js.
  • Implements Spanish language support with stemming and stop word
    filtering.
  • Registers Spanish-specific pipeline functions for Lunr.js.
  • +1/-0     
    lunr.fr.js
    Add French language support for Lunr.js.                                 

    docs/api/py/_static/javascripts/lunr/lunr.fr.js

  • Added a new JavaScript file lunr.fr.js for Lunr.js.
  • Provides French language support including stemming and stop word
    filtering.
  • Registers French-specific pipeline functions for Lunr.js.
  • +1/-0     
    lunr.jp.js
    Add Japanese language redirection for Lunr.js.                     

    docs/api/py/_static/javascripts/lunr/lunr.jp.js

  • Added a new JavaScript file lunr.jp.js for Lunr.js.
  • Redirects to lunr.ja for Japanese language support.
  • +1/-0     
    lunr.pt.js
    Add Portuguese language support for Lunr.js.                         

    docs/api/py/_static/javascripts/lunr/lunr.pt.js

  • Added a new JavaScript file for Portuguese language support in
    Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    lunr.hu.js
    Add Hungarian language support for Lunr.js.                           

    docs/api/py/_static/javascripts/lunr/lunr.hu.js

  • Added a new JavaScript file for Hungarian language support in Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    searchtools.js
    Improve search tools with highlighting and query handling.

    docs/api/py/_static/searchtools.js

  • Updated copyright year to 2024.
  • Enhanced search result display with term highlighting.
  • Improved search query handling and result ordering.
  • Added support for anchored content extraction.
  • +125/-71
    lunr.fi.js
    Add Finnish language support for Lunr.js.                               

    docs/api/py/_static/javascripts/lunr/lunr.fi.js

  • Added a new JavaScript file for Finnish language support in Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    lunr.ru.js
    Add Russian language support for Lunr.js.                               

    docs/api/py/_static/javascripts/lunr/lunr.ru.js

  • Added a new JavaScript file for Russian language support in Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    lunr.du.js
    Add deprecated Dutch language support for Lunr.js.             

    docs/api/py/_static/javascripts/lunr/lunr.du.js

  • Added a new JavaScript file for Dutch (deprecated "du" code) language
    support in Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Added a warning about deprecation of "du" in favor of "nl".
  • +1/-0     
    lunr.nl.js
    Add Dutch language support for Lunr.js.                                   

    docs/api/py/_static/javascripts/lunr/lunr.nl.js

  • Added a new JavaScript file for Dutch language support in Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    lunr.de.js
    Add German language support for Lunr.js.                                 

    docs/api/py/_static/javascripts/lunr/lunr.de.js

  • Added a new JavaScript file for German language support in Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    lunr.da.js
    Add Danish language support for Lunr.js.                                 

    docs/api/py/_static/javascripts/lunr/lunr.da.js

  • Added a new JavaScript file for Danish language support in Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    lunr.no.js
    Add Norwegian language support for Lunr.js.                           

    docs/api/py/_static/javascripts/lunr/lunr.no.js

  • Added a new JavaScript file for Norwegian language support in Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    lunr.ja.js
    Add Japanese language support for Lunr.js.                             

    docs/api/py/_static/javascripts/lunr/lunr.ja.js

  • Added a new JavaScript file for Japanese language support in Lunr.js.
  • Includes tokenizer, trimmer, and stop word filter functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    lunr.th.js
    Add Thai language support for Lunr.js.                                     

    docs/api/py/_static/javascripts/lunr/lunr.th.js

  • Added a new JavaScript file for Thai language support in Lunr.js.
  • Includes tokenizer and trimmer functionalities.
  • Provides error handling for missing dependencies.
  • +1/-0     
    lunr.sv.js
    Add Swedish language support for Lunr.js search functionality.

    docs/api/py/_static/javascripts/lunr/lunr.sv.js

  • Added a new JavaScript file for Swedish language support in Lunr.js.
  • Includes trimmer, stop word filter, and stemmer functionalities.
  • Handles Swedish-specific linguistic rules for search indexing.
  • +1/-0     
    lunr.stemmer.support.js
    Add stemmer support utilities for Lunr.js.                             

    docs/api/py/_static/javascripts/lunr/lunr.stemmer.support.js

  • Added a new JavaScript file for stemmer support in Lunr.js.
  • Provides utilities for stemming and text processing.
  • Includes SnowballProgram and Among classes for linguistic operations.
  • +1/-0     
    sphinx_highlight.js
    Improve highlighting functionality and search page behavior.

    docs/api/py/_static/sphinx_highlight.js

  • Enhanced the _highlight function to recursively highlight multiple
    occurrences in a node.
  • Modified the initialization to avoid highlighting search terms on the
    search page.
  • +13/-3   
    version_dropdown.js
    Add dynamic version dropdown menu functionality.                 

    docs/api/py/_static/javascripts/version_dropdown.js

  • Added a new JavaScript file to dynamically create a version dropdown
    menu.
  • Fetches version data from a JSON file and appends it to the navigation
    header.
  • +29/-0   
    lunr.multi.js
    Add multi-language support for Lunr.js search functionality.

    docs/api/py/_static/javascripts/lunr/lunr.multi.js

  • Added a new JavaScript file for multi-language support in Lunr.js.
  • Combines multiple language-specific configurations for search
    indexing.
  • +1/-0     
    material.css
    Add CSS for dropdown menu styling.                                             

    docs/api/py/_static/material.css

  • Added a new CSS file for dropdown menu styling.
  • Includes styles for dropdown buttons and hover effects.
  • +35/-0   
    basic.css
    Update basic CSS with visited link styling.                           

    docs/api/py/_static/basic.css

    • Updated copyright year to 2024.
    • Added styling for visited links.
    +5/-1     
    Dependencies
    2 files
    modernizr.js
    Add Modernizr library for feature detection.                         

    docs/api/py/_static/javascripts/modernizr.js

  • Added a new JavaScript file for Modernizr library.
  • Provides feature detection for various web technologies.
  • +1/-0     
    material-icons.css
    Add Material Icons font CSS.                                                         

    docs/api/py/_static/fonts/material-icons.css

  • Added a new CSS file for Material Icons font.
  • Includes font-face definitions and licensing information.
  • +13/-0   
    Documentation
    3 files
    language_data.js
    Update copyright and clarify comments in language data.   

    docs/api/py/_static/language_data.js

  • Updated copyright year to 2024.
  • Minor comment adjustment for clarity regarding non-minified version
    availability.
  • +2/-2     
    doctools.js
    Update copyright year in doctools.js.                                       

    docs/api/py/_static/doctools.js

    • Updated copyright year to 2024.
    +1/-1     
    selenium.webdriver.chromium.options.html
    Revamp HTML structure for Chromium options documentation.

    docs/api/py/webdriver_chromium/selenium.webdriver.chromium.options.html

  • Updated HTML structure and styling for the documentation page.
  • Added metadata, navigation, and footer elements.
  • Improved accessibility and search functionality.
  • [link]   
    Configuration changes
    1 files
    documentation_options.js
    Update documentation options for version 4.30.0.                 

    docs/api/py/_static/documentation_options.js

  • Changed DOCUMENTATION_OPTIONS to const.
  • Updated version number to 4.30.0.
  • +2/-3     
    Formatting
    5 files
    selenium.webdriver.common.bidi.cdp.rst.txt
    Clean up formatting in bidi.cdp documentation.                     

    docs/api/py/_sources/webdriver/selenium.webdriver.common.bidi.cdp.rst.txt

    • Removed excessive blank lines for cleaner formatting.
    +1/-18   
    selenium.webdriver.common.virtual_authenticator.rst.txt
    Clean up formatting in virtual authenticator documentation.

    docs/api/py/_sources/webdriver/selenium.webdriver.common.virtual_authenticator.rst.txt

    • Removed excessive blank lines for cleaner formatting.
    +1/-18   
    selenium.webdriver.remote.webdriver.rst.txt
    Clean up formatting in remote webdriver documentation.     

    docs/api/py/_sources/webdriver/selenium.webdriver.remote.webdriver.rst.txt

    • Removed excessive blank lines for cleaner formatting.
    selenium.webdriver.support.expected_conditions.rst.txt
    Clean up formatting in expected conditions documentation.

    docs/api/py/_sources/webdriver_support/selenium.webdriver.support.expected_conditions.rst.txt

    • Removed excessive blank lines for cleaner formatting.
    +1/-18   
    selenium.webdriver.support.event_firing_webdriver.rst.txt
    Clean up formatting in event firing webdriver documentation.

    docs/api/py/_sources/webdriver_support/selenium.webdriver.support.event_firing_webdriver.rst.txt

    • Removed excessive blank lines for cleaner formatting.
    +1/-18   
    Additional files
    101 files
    .buildinfo +1/-1     
    index.html +203/-56
    exceptions.html +412/-164
    options.html +216/-64
    remote_connection.html +212/-63
    service.html +212/-63
    webdriver.html +215/-66
    options.html +254/-93
    remote_connection.html +222/-73
    service.html +219/-67
    webdriver.html +306/-118
    action_chains.html +343/-134
    action_builder.html +267/-100
    input_device.html +225/-67
    interaction.html +227/-72
    key_actions.html +229/-68
    key_input.html +239/-72
    mouse_button.html +210/-61
    pointer_actions.html +261/-79
    pointer_input.html +246/-79
    wheel_actions.html +220/-65
    wheel_input.html +245/-78
    alert.html +237/-79
    cdp.html +406/-188
    console.html +213/-64
    script.html +265/-89
    session.html +222/-70
    by.html +244/-86
    desired_capabilities.html +241/-92
    driver_finder.html +242/-87
    keys.html +272/-123
    log.html +265/-104
    options.html +408/-254
    print_page_options.html +365/-183
    proxy.html +372/-208
    selenium_manager.html +257/-105
    service.html +275/-105
    timeouts.html +238/-89
    utils.html +252/-84
    virtual_authenticator.html +300/-121
    window.html +214/-65
    options.html +218/-66
    remote_connection.html +212/-63
    service.html +213/-64
    webdriver.html +215/-66
    firefox_binary.html +287/-126
    firefox_profile.html +324/-163
    options.html +253/-89
    remote_connection.html +216/-67
    service.html +221/-69
    webdriver.html +285/-109
    options.html +356/-198
    service.html +224/-72
    webdriver.html +221/-69
    bidi_connection.html +210/-61
    command.html +304/-155
    errorhandler.html [link]   
    file_detector.html [link]   
    mobile.html [link]   
    remote_connection.html [link]   
    script_key.html +211/-62
    shadowroot.html +243/-88
    switch_to.html +256/-92
    utils.html +214/-62
    webdriver.html +812/-486
    webelement.html +429/-233
    websocket_connection.html +242/-81
    options.html +238/-89
    permissions.html +213/-64
    remote_connection.html +214/-65
    service.html +222/-70
    webdriver.html +237/-76
    abstract_event_listener.html +288/-82
    color.html +383/-231
    event_firing_webdriver.html +305/-111
    expected_conditions.html +471/-230
    relative_locator.html +356/-171
    select.html +309/-139
    wait.html +240/-85
    options.html +228/-76
    service.html +221/-69
    webdriver.html +220/-68
    options.html +224/-72
    service.html +218/-66
    webdriver.html +220/-68
    selenium.common.exceptions.rst.txt +1/-18   
    index.rst.txt +43/-34 
    selenium.webdriver.common.action_chains.rst.txt +1/-18   
    selenium.webdriver.common.actions.action_builder.rst.txt +1/-18   
    selenium.webdriver.common.actions.input_device.rst.txt +1/-18   
    selenium.webdriver.common.actions.interaction.rst.txt +1/-18   
    selenium.webdriver.common.actions.key_actions.rst.txt +1/-18   
    selenium.webdriver.common.actions.key_input.rst.txt +1/-18   
    selenium.webdriver.common.actions.mouse_button.rst.txt +1/-18   
    selenium.webdriver.common.actions.pointer_actions.rst.txt +1/-18   
    selenium.webdriver.common.actions.pointer_input.rst.txt +1/-18   
    selenium.webdriver.common.actions.wheel_actions.rst.txt +1/-18   
    selenium.webdriver.common.actions.wheel_input.rst.txt +1/-18   
    selenium.webdriver.common.alert.rst.txt +1/-18   
    selenium.webdriver.common.bidi.console.rst.txt +1/-18   
    Additional files not shown

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @titusfortner titusfortner requested a review from cgoldberg March 21, 2025 23:51
    Copy link
    Contributor

    @cgoldberg cgoldberg left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    👍

    @titusfortner titusfortner merged commit 507e709 into gh-pages Mar 22, 2025
    1 check passed
    @titusfortner titusfortner deleted the api-docs-4.30.0-py branch March 22, 2025 03:16
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants