-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
[py] Configure readthedocs publishing for Python API docs #15614
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
Merged
Merged
Changes from 11 commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
f3aadf4
Update readthedocs configuration
cgoldberg b3473e9
Update readthedocs config
cgoldberg 90a70d3
Update readthedocs config
cgoldberg 497eaa5
Update readthedocs config
cgoldberg 72f8a0f
Update readthedocs config
cgoldberg 590eb5c
Update readthedocs config
cgoldberg 36d705a
Update readthedocs config
cgoldberg 0b358ca
Update readthedocs config
cgoldberg 16e1116
Update readthedocs config
cgoldberg 6bb3a36
Update readthedocs config
cgoldberg 98c1bc6
Update readthedocs config amd change api doc link
cgoldberg 3f63d78
Update .readthedocs.yaml
cgoldberg bfc0c2c
Update readthedocs config
cgoldberg 4f25b5a
Move readthedocs config file to python directory
cgoldberg f79b87e
Update Python docs
cgoldberg 0adc5d8
Fix index.rst
cgoldberg ad71454
Update links to drivers in docs
cgoldberg e8af501
Minor updates to Python docs
cgoldberg a45492e
Update environment variable
cgoldberg adb498d
Build docs with Python 3.13
cgoldberg 88deeb7
Fix grammatical error
cgoldberg 30dad06
Merge branch 'trunk' into readthedocs-config
cgoldberg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,21 @@ | ||
| # .readthedocs.yaml | ||
| # Read the Docs configuration file | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
| # | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for configuration options | ||
| # See https://app.readthedocs.org/projects/selenium-python-api-docs for job configuration | ||
| # See https://selenium-python-api-docs.readthedocs.io for published docs | ||
|
|
||
| # Required | ||
| version: 2 | ||
|
|
||
| # Set the OS, Python version and other tools you might need | ||
| build: | ||
| os: ubuntu-22.04 | ||
| os: ubuntu-24.04 | ||
| tools: | ||
| python: "3.11" | ||
| # You can also specify other tool versions: | ||
| # nodejs: "19" | ||
| # rust: "1.64" | ||
| # golang: "1.19" | ||
| python: "latest" | ||
| commands: | ||
| - pip install -r py/docs/requirements.txt | ||
| - pip install -r py/requirements.txt | ||
| - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst | ||
| - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html | ||
|
|
||
| # Build documentation in the "docs/" directory with Sphinx | ||
| sphinx: | ||
| configuration: py/docs/source/conf.py | ||
|
|
||
| # Optionally build your docs in additional formats such as PDF and ePub | ||
| # formats: | ||
| # - epub | ||
|
|
||
| # Optional but recommended, declare the Python requirements required | ||
| # to build your documentation | ||
| # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
| python: | ||
| install: | ||
| - requirements: py/docs/requirements.txt | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.