Skip to content

[🐛 Bug]: Missing class methods in API documentation #11004

@GergelyKalmar

Description

@GergelyKalmar

What happened?

The API documentation for the WebDriver classes is missing the methods that can be invoked on said classes (see for example https://www.selenium.dev/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.webdriver.html).

The API documentation is also missing the canonical shorter path aliases (e.g. selenium.webdriver.Chrome is not documented).

You might be able to fix the former by including the following in your Sphinx configuration:

autodoc_default_options = {
    'members': True,
    'member-order': 'bysource',
    'undoc-members': True,
    'inherited-members': True,
}

How can we reproduce the issue?

Check the API documentation at https://www.selenium.dev/selenium/docs/api/py/api.html.

Relevant log output

N/A

Operating System

N/A

Selenium version

N/A

What are the browser(s) and version(s) where you see this issue?

N/A

What are the browser driver(s) and version(s) where you see this issue?

N/A

Are you using Selenium Grid?

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    B-docsAPI Docs; see other repo for website documentationC-pyPython BindingsI-defectSomething is not working as intended

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions