Skip to content

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


Description

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

  • Added support for multiple languages in Lunr.js, including Finnish, Russian, German, and more, with trimmers, stemmers, and stop word filters.

  • Enhanced search functionality with highlighting, modularization, and improved result ordering.

  • Integrated Modernizr for feature detection and added a dynamic version dropdown menu for documentation.

  • Updated metadata, comments, and copyright years in various files.

  • Added new CSS and JavaScript files for improved functionality and support.

  • Deprecated Dutch ("du") language code in favor of "nl" in Lunr.js.


Changes walkthrough 📝

Relevant files
Enhancement
25 files
tinyseg.js
Add Lunr TinySegmenter JavaScript for Japanese text segmentation.

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

  • Added a new JavaScript file for Lunr's TinySegmenter functionality.
  • Includes segmentation logic for Japanese text processing.
  • +1/-0     
    lunr.tr.js
    Add Lunr Turkish language support with stemmer and filters.

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

  • Added a new JavaScript file for Lunr's Turkish language support.
  • Includes trimmer, stemmer, and stop word filter for Turkish.
  • +1/-0     
    lunr.ro.js
    Add Lunr Romanian language support with stemmer and filters.

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

  • Added a new JavaScript file for Lunr's Romanian language support.
  • Includes trimmer, stemmer, and stop word filter for Romanian.
  • +1/-0     
    lunr.it.js
    Add Lunr Italian language support with stemmer and filters.

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

  • Added a new JavaScript file for Lunr's Italian language support.
  • Includes trimmer, stemmer, and stop word filter for Italian.
  • +1/-0     
    lunr.es.js
    Add Lunr Spanish language support with stemmer and filters.

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

  • Added a new JavaScript file for Lunr's Spanish language support.
  • Includes trimmer, stemmer, and stop word filter for Spanish.
  • +1/-0     
    lunr.fr.js
    Add Lunr French language support with stemmer and filters.

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

  • Added a new JavaScript file for Lunr's French language support.
  • Includes trimmer, stemmer, and stop word filter for French.
  • +1/-0     
    lunr.jp.js
    Add Lunr Japanese language support module redirection.     

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

  • Added a new JavaScript file for Lunr's Japanese language support.
  • Redirects to the existing lunr.ja module.
  • +1/-0     
    lunr.pt.js
    Add Lunr support for Portuguese language processing.         

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

  • Added a new JavaScript file for Portuguese language support in Lunr.
  • Includes trimmer, stop word filter, and stemmer for Portuguese.
  • Registers functions for Portuguese-specific text processing.
  • +1/-0     
    lunr.hu.js
    Add Lunr support for Hungarian language processing.           

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

  • Added a new JavaScript file for Hungarian language support in Lunr.
  • Includes trimmer, stop word filter, and stemmer for Hungarian.
  • Registers functions for Hungarian-specific text processing.
  • +1/-0     
    searchtools.js
    Improve search tools with highlighting and modularization.

    docs/api/py/_static/searchtools.js

  • Updated copyright year from 2023 to 2024.
  • Enhanced search functionality with highlighting and improved result
    ordering.
  • Refactored and modularized search query handling and result
    processing.
  • +125/-71
    lunr.fi.js
    Add Lunr support for Finnish language processing.               

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

  • Added a new JavaScript file for Finnish language support in Lunr.
  • Includes trimmer, stop word filter, and stemmer for Finnish.
  • Registers functions for Finnish-specific text processing.
  • +1/-0     
    lunr.ru.js
    Add Lunr support for Russian language processing.               

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

  • Added a new JavaScript file for Russian language support in Lunr.
  • Includes trimmer, stop word filter, and stemmer for Russian.
  • Registers functions for Russian-specific text processing.
  • +1/-0     
    modernizr.js
    Integrate Modernizr for feature detection.                             

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

  • Added a new JavaScript file for Modernizr integration.
  • Provides feature detection capabilities for web technologies.
  • +1/-0     
    lunr.du.js
    Add deprecated Dutch ("du") support for Lunr.                       

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

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

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

  • Added a new JavaScript file for Dutch ("nl") language support in Lunr.
  • Includes trimmer, stop word filter, and stemmer for Dutch.
  • Registers functions for Dutch-specific text processing.
  • +1/-0     
    lunr.de.js
    Add Lunr support for German language processing.                 

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

  • Added a new JavaScript file for German language support in Lunr.
  • Includes trimmer, stop word filter, and stemmer for German.
  • Registers functions for German-specific text processing.
  • +1/-0     
    lunr.da.js
    Add Lunr support for Danish language processing.                 

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

  • Added a new JavaScript file for Danish language support in Lunr.
  • Includes trimmer, stop word filter, and stemmer for Danish.
  • Registers functions for Danish-specific text processing.
  • +1/-0     
    lunr.no.js
    Add Lunr support for Norwegian language processing.           

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

  • Added a new JavaScript file for Norwegian language support in Lunr.
  • Includes trimmer, stop word filter, and stemmer for Norwegian.
  • Registers functions for Norwegian-specific text processing.
  • +1/-0     
    lunr.ja.js
    Add Lunr support for Japanese language processing.             

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

  • Added a new JavaScript file for Japanese language support in Lunr.
  • Includes tokenizer, stop word filter, and stemmer for Japanese.
  • Registers functions for Japanese-specific text processing.
  • +1/-0     
    lunr.th.js
    Add Lunr support for Thai language processing.                     

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

  • Added a new JavaScript file for Thai language support in Lunr.
  • Includes tokenizer and trimmer for Thai.
  • Registers functions for Thai-specific text processing.
  • +1/-0     
    lunr.sv.js
    Add Swedish language support for Lunr.js.                               

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

  • Added a new JavaScript file for Swedish language support in Lunr.js.
  • Includes trimmer, stemmer, and stop word filter functionalities.
  • Registers Swedish-specific pipeline functions for Lunr.js.
  • +1/-0     
    lunr.stemmer.support.js
    Add stemmer support utility 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 utility functions for stemming and text processing.
  • Includes SnowballProgram and Among classes for advanced stemming.
  • +1/-0     
    sphinx_highlight.js
    Enhance search term highlighting logic in Sphinx.               

    docs/api/py/_static/sphinx_highlight.js

  • Improved the highlighting function to handle multiple occurrences of
    search terms.
  • Added a conditional check to avoid highlighting on the search page.
  • Enhanced recursive processing for search term fragments.
  • +13/-3   
    version_dropdown.js
    Add dynamic version dropdown for documentation.                   

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

  • Added a new JavaScript file to create a version dropdown menu.
  • Dynamically fetches version data from a JSON file.
  • Appends the dropdown to the navigation header.
  • +29/-0   
    lunr.multi.js
    Add multi-language support for Lunr.js.                                   

    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 pipelines into one.
  • Registers a multi-language trimmer function.
  • +1/-0     
    Documentation
    3 files
    language_data.js
    Update metadata and comments in language data script.       

    docs/api/py/_static/language_data.js

  • Updated copyright year to 2024.
  • Corrected a comment regarding the availability of non-minified JS
    files.
  • +2/-2     
    doctools.js
    Update copyright year in doctools script.                               

    docs/api/py/_static/doctools.js

    • Updated copyright year to 2024.
    +1/-1     
    genindex-S.html
    Add index page for "S" entries in documentation.                 

    docs/api/py/genindex-S.html

  • Added a new HTML file for the index page of the documentation.
  • Includes a comprehensive list of modules, classes, and methods
    starting with "S".
  • Implements a responsive layout and search functionality.
  • +1649/-0
    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 use const instead of var.
  • Updated the version to 4.30.0.
  • Removed the URL_ROOT property.
  • +2/-3     
    Dependencies
    1 files
    material-icons.css
    Add Material Icons font CSS file.                                               

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

  • Added a new CSS file for Material Icons font.
  • Specifies font-face properties and sources for Material Icons.
  • Includes licensing information for the font.
  • +13/-0   
    Additional files
    101 files
    api.doctree [link]   
    selenium.common.exceptions.doctree [link]   
    index.doctree [link]   
    selenium.webdriver.common.action_chains.doctree [link]   
    selenium.webdriver.common.actions.action_builder.doctree [link]   
    selenium.webdriver.common.actions.input_device.doctree [link]   
    selenium.webdriver.common.actions.interaction.doctree [link]   
    selenium.webdriver.common.actions.key_actions.doctree [link]   
    selenium.webdriver.common.actions.key_input.doctree [link]   
    selenium.webdriver.common.actions.mouse_button.doctree [link]   
    selenium.webdriver.common.actions.pointer_actions.doctree [link]   
    selenium.webdriver.common.actions.pointer_input.doctree [link]   
    selenium.webdriver.common.actions.wheel_actions.doctree [link]   
    selenium.webdriver.common.actions.wheel_input.doctree [link]   
    selenium.webdriver.common.alert.doctree [link]   
    selenium.webdriver.common.bidi.cdp.doctree [link]   
    selenium.webdriver.common.bidi.console.doctree [link]   
    selenium.webdriver.common.bidi.script.doctree [link]   
    selenium.webdriver.common.bidi.session.doctree [link]   
    selenium.webdriver.common.by.doctree [link]   
    selenium.webdriver.common.desired_capabilities.doctree [link]   
    selenium.webdriver.common.driver_finder.doctree [link]   
    selenium.webdriver.common.keys.doctree [link]   
    selenium.webdriver.common.log.doctree [link]   
    selenium.webdriver.common.options.doctree [link]   
    selenium.webdriver.common.print_page_options.doctree [link]   
    selenium.webdriver.common.proxy.doctree [link]   
    selenium.webdriver.common.selenium_manager.doctree [link]   
    selenium.webdriver.common.service.doctree [link]   
    selenium.webdriver.common.timeouts.doctree [link]   
    selenium.webdriver.common.utils.doctree [link]   
    selenium.webdriver.common.virtual_authenticator.doctree [link]   
    selenium.webdriver.common.window.doctree [link]   
    selenium.webdriver.chrome.options.doctree [link]   
    selenium.webdriver.chrome.remote_connection.doctree [link]   
    selenium.webdriver.chrome.service.doctree [link]   
    selenium.webdriver.chrome.webdriver.doctree [link]   
    selenium.webdriver.chromium.options.doctree [link]   
    selenium.webdriver.chromium.remote_connection.doctree [link]   
    selenium.webdriver.chromium.service.doctree [link]   
    selenium.webdriver.chromium.webdriver.doctree [link]   
    selenium.webdriver.edge.options.doctree [link]   
    selenium.webdriver.edge.remote_connection.doctree [link]   
    selenium.webdriver.edge.service.doctree [link]   
    selenium.webdriver.edge.webdriver.doctree [link]   
    selenium.webdriver.firefox.firefox_binary.doctree [link]   
    selenium.webdriver.firefox.firefox_profile.doctree [link]   
    selenium.webdriver.firefox.options.doctree [link]   
    selenium.webdriver.firefox.remote_connection.doctree [link]   
    selenium.webdriver.firefox.service.doctree [link]   
    selenium.webdriver.firefox.webdriver.doctree [link]   
    selenium.webdriver.ie.options.doctree [link]   
    selenium.webdriver.ie.service.doctree [link]   
    selenium.webdriver.ie.webdriver.doctree [link]   
    selenium.webdriver.remote.bidi_connection.doctree [link]   
    selenium.webdriver.remote.command.doctree [link]   
    selenium.webdriver.remote.errorhandler.doctree [link]   
    selenium.webdriver.remote.file_detector.doctree [link]   
    selenium.webdriver.remote.mobile.doctree [link]   
    selenium.webdriver.remote.remote_connection.doctree [link]   
    selenium.webdriver.remote.script_key.doctree [link]   
    selenium.webdriver.remote.shadowroot.doctree [link]   
    selenium.webdriver.remote.switch_to.doctree [link]   
    selenium.webdriver.remote.utils.doctree [link]   
    selenium.webdriver.remote.webdriver.doctree [link]   
    selenium.webdriver.remote.webelement.doctree [link]   
    selenium.webdriver.remote.websocket_connection.doctree [link]   
    selenium.webdriver.safari.options.doctree [link]   
    selenium.webdriver.safari.permissions.doctree [link]   
    selenium.webdriver.safari.remote_connection.doctree [link]   
    selenium.webdriver.safari.service.doctree [link]   
    selenium.webdriver.safari.webdriver.doctree [link]   
    selenium.webdriver.support.abstract_event_listener.doctree [link]   
    selenium.webdriver.support.color.doctree [link]   
    selenium.webdriver.support.event_firing_webdriver.doctree [link]   
    selenium.webdriver.support.events.doctree [link]   
    selenium.webdriver.support.expected_conditions.doctree [link]   
    selenium.webdriver.support.relative_locator.doctree [link]   
    selenium.webdriver.support.select.doctree [link]   
    selenium.webdriver.support.ui.doctree [link]   
    selenium.webdriver.support.wait.doctree [link]   
    selenium.webdriver.webkitgtk.options.doctree [link]   
    selenium.webdriver.webkitgtk.service.doctree [link]   
    selenium.webdriver.webkitgtk.webdriver.doctree [link]   
    selenium.webdriver.wpewebkit.options.doctree [link]   
    selenium.webdriver.wpewebkit.service.doctree [link]   
    selenium.webdriver.wpewebkit.webdriver.doctree [link]   
    .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
    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.
  • @qodo-merge-pro
    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

    @qodo-merge-pro
    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @titusfortner
    Copy link
    Member

    Ah, I see what is going on. closing

    @titusfortner titusfortner added B-docs API Docs; see other repo for website documentation and removed documentation labels Mar 30, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    B-docs API Docs; see other repo for website documentation Review effort 1/5

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants