Skip to content

[py] Include generated BiDi modules in API docs #17375

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.

Sign up for GitHub

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

Open
cgoldberg wants to merge 1 commit into
base: trunk
Choose a base branch
from
+4 −0
Open

[py] Include generated BiDi modules in API docs #17375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions py/docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ webdriver.common

selenium.webdriver.common.action_chains
selenium.webdriver.common.alert
selenium.webdriver.common.api_request_context
selenium.webdriver.common.by
selenium.webdriver.common.desired_capabilities
selenium.webdriver.common.driver_finder
Expand Down Expand Up @@ -91,6 +92,7 @@ webdriver.common.bidi
.. autosummary::
:toctree: selenium_webdriver_common_bidi

selenium.webdriver.common.bidi._event_manager
selenium.webdriver.common.bidi.browser
selenium.webdriver.common.bidi.browsing_context
selenium.webdriver.common.bidi.cdp
Expand Down
2 changes: 2 additions & 0 deletions rake_tasks/python.rake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ task :docs do |_task, arguments|
abort('Aborting documentation update: nightly versions should not update docs.')
end

# Run this task so generated modules are copied into the source tree before generating docs
Rake::Task['py:local_dev'].invoke
Rake::Task['py:docs_generate'].invoke
Comment thread
cgoldberg marked this conversation as resolved.

FileUtils.mkdir_p('build/docs/api')
Expand Down
Loading