-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
[🚀 Feature]: Auto-generate the Python API from the code #14178
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
Comments
@emanlove, thank you for creating this issue. We will troubleshoot it as soon as we can. Info for maintainersTriage this issue by using labels.
If information is missing, add a helpful comment and then
If the issue is a question, add the
If the issue is valid but there is no time to troubleshoot it, consider adding the
If the issue requires changes or fixes from an external project (e.g., ChromeDriver, GeckoDriver, MSEdgeDriver, W3C),
add the applicable
After troubleshooting the issue, please add the Thank you! |
This issue is looking for contributors. Please comment below or reach out to us through our IRC/Slack/Matrix channels if you are interested. |
I'm assuming we don't want to import a library for this correct? so to minimize dependencies |
@shbenzer, I believe it can be done with the current sphinx build process without any additional packages. I am open to suggestions on other ways to do this. |
This issue is stale because it has been open 280 days with no activity. Remove stale label or comment or this will be closed in 14 days. |
This would be a nice feature, and we did run into this situation recently. Some new modules were added, but I haven't really looked into it, but any suggestions for auto-generating the docs without declaring modules in |
I just implemented this in #15822 |
Feature and motivation
Some recent improvements have been made to the generation of the Python API documentation. Now the Python API doc is generated from the py/docs/source/api.st "template". Taking this a step further we should be able to generate the API from just the code itself. This is important as any updates to the code, for example recent additions with selenium.webdriver.common.bidi, needs to be manually added to this api.rst file, as shown here
And if we forgot to add, say selenium.webdriver.common.bidi.script, then it would be missing from the doc. So it would be good to either fully auto-generate it or have some automatic method to check for completeness and changes.
Usage example
Might add a step to the tox.ini to autogenerate the api doc from the code or check for completeness.
The text was updated successfully, but these errors were encountered: