Added requirements.txt to doc build environment#14171
Merged
titusfortner merged 1 commit intoSeleniumHQ:trunkfrom Jun 22, 2024
Merged
Added requirements.txt to doc build environment#14171titusfortner merged 1 commit intoSeleniumHQ:trunkfrom
titusfortner merged 1 commit intoSeleniumHQ:trunkfrom
Conversation
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.
Contributor
PR Reviewer Guide 🔍
|
Contributor
PR Code Suggestions ✨
|
Contributor
8 tasks
sandeepsuryaprasad
pushed a commit
to sandeepsuryaprasad/selenium
that referenced
this pull request
Oct 29, 2024
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.
M1troll
pushed a commit
to M1troll/selenium
that referenced
this pull request
May 14, 2025
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.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
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.
Description
This adds the requirments.txt to the tox docs build environment.
Motivation and Context
The Sphinx Python API docs are built by "reading the code". That is as if Python were importing or running it. Thus the required
dependencies to run the Python bindings are also require to build the API documentation.
Types of changes
Checklist
PR Type
Bug fix, Documentation
Description
requirements.txtto the dependencies list in the tox configuration to ensure all necessary packages are available for building the API documentation with Sphinx.Changes walkthrough 📝
tox.ini
Include `requirements.txt` in tox documentation build environmentpy/tox.ini
requirements.txtto the dependencies list in the toxconfiguration.