-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[py] Update Documentation api.rst File List #14172
Conversation
PR Reviewer Guide 🔍
|
PR Code Suggestions ✨
|
@iampopovich was this code automatically generated? |
No, I think we should close this pull request and continue figuring out how to fix the document generation globally using Sphinx. |
If this is going to generate the right things for 4.22, though, I'd like to get something updated and then we can figure out the automated way to do this going forward? |
Hm After I manually added new classes and removed non-existent ones, new .rst documents were generated automatically. When I ran it locally, I got a dialog asking, "Do you want to update the documentation?" I declined, but I think even if I had agreed, I wouldn't have had the write permissions to update the documentation in production. Is there a way to check the validity of the created documents without updating the existing documentation? I saw that sphinx can generate HTML, but unfortunately, I'm not at my computer right now. |
Some documents that were generated locally were not included in the commits. These are the files with documentation for bidi. This can be checked by running |
You can't break anything. The current code
So we just need to get |
Oh yeah, I just changed what |
311d79a
to
d842e44
Compare
@titusfortner you can see in my latest commit that new documents were generated according to the list of files in api.rst guess we can use manually updated api.rst for the 4.22.0 documentation |
Closing this in favor of #14173 |
User description
Thanks for contributing to Selenium!
A PR well described will help maintainers to quickly review and merge it
Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, help reviewers by making them as simple and short as possible.
Description
trying to fix documentation for current and obsolete classes according to issue #13910
Motivation and Context
Types of changes
Checklist
PR Type
Documentation, Bug fix
Description
DriverFinder
implementation.api.rst
to include new and reordered entries, ensuring alphabetical order.NoSuchDriverException
to the exceptions list inselenium.common.exceptions
.selenium.webdriver.common.driver_finder
andselenium.webdriver.common.selenium_manager
.PageLoadStrategy
to the autosummary list inselenium.webdriver.common.options
.selenium.webdriver.firefox.extension_connection
.requirements.txt
to the dependencies list intox.ini
.Changes walkthrough 📝
driver_finder.py
Add module-level docstring for DriverFinder
py/selenium/webdriver/common/driver_finder.py
DriverFinder
implementation.api.rst
Update and reorder module list in api.rst
py/docs/source/api.rst
api.rst
to include new and reorderedentries.
selenium.common.exceptions.rst
Add NoSuchDriverException to exceptions list
py/docs/source/common/selenium.common.exceptions.rst
NoSuchDriverException
to the exceptions list.selenium.webdriver.common.driver_finder.rst
Add documentation for selenium.webdriver.common.driver_finder
py/docs/source/webdriver/selenium.webdriver.common.driver_finder.rst
selenium.webdriver.common.driver_finder
.selenium.webdriver.common.options.rst
Add PageLoadStrategy to options documentation
py/docs/source/webdriver/selenium.webdriver.common.options.rst
PageLoadStrategy
to the autosummary list.selenium.webdriver.common.selenium_manager.rst
Add documentation for selenium.webdriver.common.selenium_manager
py/docs/source/webdriver/selenium.webdriver.common.selenium_manager.rst
selenium.webdriver.common.selenium_manager
.selenium.webdriver.firefox.extension_connection.rst
Remove obsolete firefox extension connection documentation
py/docs/source/webdriver_firefox/selenium.webdriver.firefox.extension_connection.rst
selenium.webdriver.firefox.extension_connection
.tox.ini
Add requirements.txt to tox dependencies
py/tox.ini
requirements.txt
to the dependencies list intox.ini
.