forked from SeleniumHQ/selenium
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates the py api doc build (SeleniumHQ#14173)
* Added requirements.txt to doc build environment For the API documentation as sphinx autogenerates the api docs from the code it needs the dependent Python packages. This change adds those to the tox docs build environment. * Updated Sphinx version within docs/requirements.txt Bring Sphinx version up to the latest Python 3.8 suported version, v7.1.2. This change was made within py/docs/requirements.txt. It should be noted that there is a seperate version requirement given within py/tox.ini which I need to test and see which one is grabed using the selenium build process. (I supsect it will be the one within py/tox.ini.) * Added step in api doc build to regenerate the autodoc stub pages Instead of using the commited stub files which contain "pre-compiled" outlines for the api doc this will regenrate them. It should be noted this might add some time to the build process so a future change might be to see how store and update either commited files or previous build artifacts. I also and working though the output directory which is currently set to `-o docs/source`. This seem to dump all the sub files into the main source directory insted of neatly organied into child directories. Going to try to reowrk this but wanted to commit so as not to lose how I did this the first time ;) * wip adding new files in api.rst Credit goes to @iampopovich for these changes * wip alphabetical order in api.rst Credit goes to @iampopovich for these changes * Removed previous generated api doc stub files Prefer instead to auto-generate these as part of the build. Also ignore those sub-directories. * Updated the tox api doc build steps - Use the docs/requirements.txt file instead of repeating the build versions for jinja and sphinx - Removed the output directory option on sphinx-autogen as that was putting everything in a flat directory structure at the root instead of the well organized folders
- Loading branch information
1 parent
3d4d8e3
commit 8aacfb1
Showing
75 changed files
with
47 additions
and
2,205 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
Jinja2==3.1.4 | ||
Sphinx==1.8.2 | ||
Sphinx==7.1.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
29 changes: 0 additions & 29 deletions
29
py/docs/source/webdriver/selenium.webdriver.common.action_chains.rst
This file was deleted.
Oops, something went wrong.
29 changes: 0 additions & 29 deletions
29
py/docs/source/webdriver/selenium.webdriver.common.actions.action_builder.rst
This file was deleted.
Oops, something went wrong.
29 changes: 0 additions & 29 deletions
29
py/docs/source/webdriver/selenium.webdriver.common.actions.input_device.rst
This file was deleted.
Oops, something went wrong.
30 changes: 0 additions & 30 deletions
30
py/docs/source/webdriver/selenium.webdriver.common.actions.interaction.rst
This file was deleted.
Oops, something went wrong.
29 changes: 0 additions & 29 deletions
29
py/docs/source/webdriver/selenium.webdriver.common.actions.key_actions.rst
This file was deleted.
Oops, something went wrong.
30 changes: 0 additions & 30 deletions
30
py/docs/source/webdriver/selenium.webdriver.common.actions.key_input.rst
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.