From f3aadf463e838d5c1d7942b587b4e24906bc2dfb Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:17:04 -0400 Subject: [PATCH 01/21] Update readthedocs configuration --- .readthedocs.yaml | 23 ++++++----------------- 1 file changed, 6 insertions(+), 17 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index ea69ba8052a4a..341252b60a559 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -2,31 +2,20 @@ # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -# Required version: 2 -# Set the OS, Python version and other tools you might need build: os: ubuntu-22.04 tools: - python: "3.11" - # You can also specify other tool versions: - # nodejs: "19" - # rust: "1.64" - # golang: "1.19" + python: "latest" -# Build documentation in the "docs/" directory with Sphinx sphinx: configuration: py/docs/source/conf.py + commands: + - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst + - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html -# Optionally build your docs in additional formats such as PDF and ePub -# formats: -# - pdf -# - 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 + - requirements: py/docs/requirements.txt + - requirements: py/requirements.txt From b3473e92479a661edd189233ecceb81cf06988c6 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:30:42 -0400 Subject: [PATCH 02/21] Update readthedocs config --- .readthedocs.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 341252b60a559..c43a34bd8bd7f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,12 +8,12 @@ build: os: ubuntu-22.04 tools: python: "latest" + commands: + - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst + - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html sphinx: configuration: py/docs/source/conf.py - commands: - - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst - - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html python: install: From 90a70d3fabd0fc83b2738e5fd9e942a2e6453a47 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:35:22 -0400 Subject: [PATCH 03/21] Update readthedocs config --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c43a34bd8bd7f..6c563ca050b0d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,7 +7,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "latest" + python: latest commands: - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html From 497eaa5ea0b6cca881fa1d44a7431a55445febd1 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:37:53 -0400 Subject: [PATCH 04/21] Update readthedocs config --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6c563ca050b0d..32e949f59b216 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,9 +5,9 @@ version: 2 build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: - python: latest + python: "3.12" commands: - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html From 72f8a0f1cfc58c175ff6f28f56c2cefd6916d296 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:39:21 -0400 Subject: [PATCH 05/21] Update readthedocs config --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 32e949f59b216..f5adf3fb4f0e0 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,8 +7,8 @@ version: 2 build: os: ubuntu-24.04 tools: - python: "3.12" - commands: + python: "latest" + commands: - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html From 590eb5c4e6d89ae80d2e3fce52c3c9dffdd8f0b9 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:41:21 -0400 Subject: [PATCH 06/21] Update readthedocs config --- .readthedocs.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f5adf3fb4f0e0..08490388e09f9 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,8 @@ build: tools: python: "latest" commands: - - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst + - export PYTHONPATH=py + - sphinx-autogen py/docs/source/api.rst - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html sphinx: From 36d705a6cf06f9e8d7d48ff28f0e31ccf0f9d027 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:56:34 -0400 Subject: [PATCH 07/21] Update readthedocs config --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 08490388e09f9..81550b7d5b45f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,6 +9,7 @@ build: tools: python: "latest" commands: + - pip install sphinx - export PYTHONPATH=py - sphinx-autogen py/docs/source/api.rst - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html From 0b358ca5c61750275c3334c7e0ba3616dd5162a1 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:57:36 -0400 Subject: [PATCH 08/21] Update readthedocs config --- .readthedocs.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 81550b7d5b45f..e171be2db2a9b 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,8 +10,7 @@ build: python: "latest" commands: - pip install sphinx - - export PYTHONPATH=py - - sphinx-autogen py/docs/source/api.rst + - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html sphinx: From 16e1116f6ba93949cab3411ee99d1864507d6c4d Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:59:21 -0400 Subject: [PATCH 09/21] Update readthedocs config --- .readthedocs.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e171be2db2a9b..c7713f233b466 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,8 @@ build: tools: python: "latest" commands: - - pip install sphinx + - 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 From 6bb3a369b2138a6b45e8d80a6fc2806030f84aea Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 20:02:00 -0400 Subject: [PATCH 10/21] Update readthedocs config --- .readthedocs.yaml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c7713f233b466..320732d6e316c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,8 +16,3 @@ build: sphinx: configuration: py/docs/source/conf.py - -python: - install: - - requirements: py/docs/requirements.txt - - requirements: py/requirements.txt From 98c1bc67f73419c2a29d84be7add51a0dff1be7b Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 20:12:41 -0400 Subject: [PATCH 11/21] Update readthedocs config amd change api doc link --- .readthedocs.yaml | 5 ++++- py/docs/source/index.rst | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 320732d6e316c..faa16ca3bcd69 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,6 +1,9 @@ # .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 version: 2 diff --git a/py/docs/source/index.rst b/py/docs/source/index.rst index e29e108349845..00dc7040babcb 100644 --- a/py/docs/source/index.rst +++ b/py/docs/source/index.rst @@ -16,7 +16,7 @@ The `selenium` package is used to automate web browser interaction from Python. +-----------------+--------------------------------------------------------------------------------------+ | **PyPI**: | https://pypi.org/project/selenium | +-----------------+--------------------------------------------------------------------------------------+ -| **API Docs**: | https://selenium.dev/selenium/docs/api/py/api.html | +| **API Docs**: | `api.html `_ | +-----------------+--------------------------------------------------------------------------------------+ | **IRC/Slack**: | `Selenium chat room `_ | +-----------------+--------------------------------------------------------------------------------------+ From 3f63d7878a78dc2d9cbf472f0d32b26202793589 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Thu, 10 Apr 2025 20:54:18 -0400 Subject: [PATCH 12/21] Update .readthedocs.yaml Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com> --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index faa16ca3bcd69..7ad0dc7deadf3 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,7 +14,7 @@ build: commands: - pip install -r py/docs/requirements.txt - pip install -r py/requirements.txt - - PYTHONPATH=py sphinx-autogen py/docs/source/api.rst + - PYTHONPATH=py sphinx-autogen -o $READTHEDOCS_OUTPUT/html py/docs/source/api.rst - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html sphinx: From bfc0c2c3c9dafd897bde72399a6c535bdde9ca36 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Fri, 11 Apr 2025 02:49:54 -0400 Subject: [PATCH 13/21] Update readthedocs config --- .readthedocs.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7ad0dc7deadf3..bf62bea74119d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,9 +1,9 @@ # .readthedocs.yaml -# Read the Docs configuration file +# configuration file for publishing Python API documentation on "Read the Docs" # -# 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 +# configuration file reference: https://docs.readthedocs.io/en/stable/config-file/v2.html +# job configuration: https://app.readthedocs.org/projects/selenium-python-api-docs +# published docs: https://selenium-python-api-docs.readthedocs.io version: 2 From 4f25b5a5feae022f3b2634323c729fbde0bc1ee4 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Fri, 11 Apr 2025 12:24:03 -0400 Subject: [PATCH 14/21] Move readthedocs config file to python directory --- .readthedocs.yaml => py/docs/.readthedocs.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .readthedocs.yaml => py/docs/.readthedocs.yaml (100%) diff --git a/.readthedocs.yaml b/py/docs/.readthedocs.yaml similarity index 100% rename from .readthedocs.yaml rename to py/docs/.readthedocs.yaml From f79b87e8fc3e24d4752e62d6c6b42adf3071c72e Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Fri, 11 Apr 2025 13:23:48 -0400 Subject: [PATCH 15/21] Update Python docs --- py/docs/source/index.rst | 63 ++++++++++++++++++++++++++-------------- 1 file changed, 42 insertions(+), 21 deletions(-) diff --git a/py/docs/source/index.rst b/py/docs/source/index.rst index 00dc7040babcb..ac6a4ba604820 100644 --- a/py/docs/source/index.rst +++ b/py/docs/source/index.rst @@ -9,25 +9,41 @@ Python language bindings for Selenium WebDriver. The `selenium` package is used to automate web browser interaction from Python. -+-----------------+--------------------------------------------------------------------------------------+ -| **Home**: | https://selenium.dev | -+-----------------+--------------------------------------------------------------------------------------+ -| **GitHub**: | https://github.com/SeleniumHQ/Selenium | -+-----------------+--------------------------------------------------------------------------------------+ -| **PyPI**: | https://pypi.org/project/selenium | -+-----------------+--------------------------------------------------------------------------------------+ -| **API Docs**: | `api.html `_ | -+-----------------+--------------------------------------------------------------------------------------+ -| **IRC/Slack**: | `Selenium chat room `_ | -+-----------------+--------------------------------------------------------------------------------------+ - -Several browsers/drivers are supported (Firefox, Chrome, Edge, Safari), as well as the Remote protocol. ++-------------------+------------------------------------------------+ +| **Home**: | https://selenium.dev | ++-------------------+------------------------------------------------+ +| **GitHub**: | https://github.com/SeleniumHQ/Selenium | ++-------------------+------------------------------------------------+ +| **PyPI**: | https://pypi.org/project/selenium | ++-------------------+------------------------------------------------+ +| **IRC/Slack**: | https://www.selenium.dev/support/#ChatRoom | ++-------------------+------------------------------------------------+ +| **Docs**: | https://www.selenium.dev/selenium/docs/api/py | ++-------------------+------------------------------------------------+ +| **API Docs**: | `api.html `_ | ++-------------------+------------------------------------------------+ + +Updated documentation published with each commit is available at: https://selenium-python-api-docs.readthedocs.io + +---- Supported Python Versions ========================= * Python 3.9+ +Supported Browsers +================== + +Several browsers are supported, as well as the Remote protocol: + +* Chrome +* Edge +* Firefox +* Safari +* WebKitGTK +* WPEWebKit + Installing ========== @@ -107,7 +123,8 @@ Example 1: Example 2: ========== -Selenium WebDriver is often used as a basis for testing web applications. Here is a simple example using Python's standard `unittest `_ library: +Selenium WebDriver is often used as a basis for testing web applications. Here is a simple example using Python's standard +`unittest `_ library: .. code-block:: python @@ -150,11 +167,15 @@ View source code online: Contributing ============= + - Fork the selenium repo and clone it locally - Create a branch for your work - - Ensure `tox` is installed (using a `virtualenv` is recommended) - - Run: `python -m venv venv && source venv/bin/activate && pip install tox` - - After making changes, before committing execute `tox -e linting` - - If tox exits `0`, commit and push. Otherwise fix the newly introduced style violations. - - `flake8` requires manual fixes - - `black` will rewrite the violations automatically, however the files are unstaged and should staged again. - - `isort` will rewrite the violations automatically, however the files are unstaged and should staged again. + - `git checkout -b my-cool-branch-name` + - Create a virtual environment and install tox + - `python -m venv venv && source venv/bin/activate && pip install tox` + - Make your changes + - Run `tox -e linting` + - If tox exits `0`, commit and push. Otherwise, fix the newly introduced style violations + - `flake8` requires manual fixes + - `black` will rewrite the violations automatically, however the files are unstaged and should staged again + - `isort` will rewrite the violations automatically, however the files are unstaged and should staged again + - Submit a Pull Request From 0adc5d8e33f732570c968c5aa6aa102a812993fe Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Fri, 11 Apr 2025 13:32:21 -0400 Subject: [PATCH 16/21] Fix index.rst --- py/docs/source/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/py/docs/source/index.rst b/py/docs/source/index.rst index ac6a4ba604820..1b994c6cf496a 100644 --- a/py/docs/source/index.rst +++ b/py/docs/source/index.rst @@ -71,11 +71,11 @@ Links to some of the more popular browser drivers: +--------------+-----------------------------------------------------------------------+ | **Chrome**: | https://chromedriver.chromium.org/downloads | +--------------+-----------------------------------------------------------------------+ -| **Edge**: | https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ | +| **Edge**: | https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver | +--------------+-----------------------------------------------------------------------+ | **Firefox**: | https://github.com/mozilla/geckodriver/releases | +--------------+-----------------------------------------------------------------------+ -| **Safari**: | https://webkit.org/blog/6900/webdriver-support-in-safari-10/ | +| **Safari**: | https://webkit.org/blog/6900/webdriver-support-in-safari-10 | +--------------+-----------------------------------------------------------------------+ Example 0: From ad71454e45251f55b075cf9d07bc9b16db46928b Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Fri, 11 Apr 2025 13:35:38 -0400 Subject: [PATCH 17/21] Update links to drivers in docs --- py/docs/source/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/py/docs/source/index.rst b/py/docs/source/index.rst index 1b994c6cf496a..7ac5e9cde3ede 100644 --- a/py/docs/source/index.rst +++ b/py/docs/source/index.rst @@ -69,11 +69,11 @@ specify browsers and drivers yourself. Links to some of the more popular browser drivers: +--------------+-----------------------------------------------------------------------+ -| **Chrome**: | https://chromedriver.chromium.org/downloads | +| **Chrome**: | https://developer.chrome.com/docs/chromedriver | +--------------+-----------------------------------------------------------------------+ | **Edge**: | https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver | +--------------+-----------------------------------------------------------------------+ -| **Firefox**: | https://github.com/mozilla/geckodriver/releases | +| **Firefox**: | https://github.com/mozilla/geckodriver | +--------------+-----------------------------------------------------------------------+ | **Safari**: | https://webkit.org/blog/6900/webdriver-support-in-safari-10 | +--------------+-----------------------------------------------------------------------+ From e8af5018a99853aaded48e1427f00bfee0b41a2f Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Fri, 11 Apr 2025 13:41:58 -0400 Subject: [PATCH 18/21] Minor updates to Python docs --- py/docs/source/index.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/py/docs/source/index.rst b/py/docs/source/index.rst index 7ac5e9cde3ede..d95c8bc030d62 100644 --- a/py/docs/source/index.rst +++ b/py/docs/source/index.rst @@ -160,22 +160,22 @@ Use The Source Luke! View source code online: -+-----------+------------------------------------------------------+ -| Official: | https://github.com/SeleniumHQ/selenium/tree/trunk/py | -+-----------+------------------------------------------------------+ ++---------------+-------------------------------------------------------+ +| **Official**: | https://github.com/SeleniumHQ/selenium/tree/trunk/py | ++---------------+-------------------------------------------------------+ Contributing ============= - Fork the selenium repo and clone it locally - Create a branch for your work - - `git checkout -b my-cool-branch-name` + - Run: `git checkout -b my-cool-branch-name` - Create a virtual environment and install tox - - `python -m venv venv && source venv/bin/activate && pip install tox` + - Run: `python -m venv venv && source venv/bin/activate && pip install tox` - Make your changes - - Run `tox -e linting` + - Run: `tox -e linting` - If tox exits `0`, commit and push. Otherwise, fix the newly introduced style violations - - `flake8` requires manual fixes - - `black` will rewrite the violations automatically, however the files are unstaged and should staged again - - `isort` will rewrite the violations automatically, however the files are unstaged and should staged again + - `flake8` requires manual fixes + - `black` will rewrite the violations automatically, however the files are unstaged and should staged again + - `isort` will rewrite the violations automatically, however the files are unstaged and should staged again - Submit a Pull Request From a45492eff4d51c182e1caa36aa65000a4782bf15 Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Fri, 11 Apr 2025 13:43:48 -0400 Subject: [PATCH 19/21] Update environment variable --- py/docs/.readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/py/docs/.readthedocs.yaml b/py/docs/.readthedocs.yaml index bf62bea74119d..07f8a6e43b681 100644 --- a/py/docs/.readthedocs.yaml +++ b/py/docs/.readthedocs.yaml @@ -15,7 +15,7 @@ build: - pip install -r py/docs/requirements.txt - pip install -r py/requirements.txt - PYTHONPATH=py sphinx-autogen -o $READTHEDOCS_OUTPUT/html py/docs/source/api.rst - - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html + - PYTHONPATH=py sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html sphinx: configuration: py/docs/source/conf.py From adb498d25167245031cc5c3ed83e960a46a4972c Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Fri, 11 Apr 2025 13:45:14 -0400 Subject: [PATCH 20/21] Build docs with Python 3.13 --- py/docs/.readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/py/docs/.readthedocs.yaml b/py/docs/.readthedocs.yaml index 07f8a6e43b681..65537815914a8 100644 --- a/py/docs/.readthedocs.yaml +++ b/py/docs/.readthedocs.yaml @@ -10,7 +10,7 @@ version: 2 build: os: ubuntu-24.04 tools: - python: "latest" + python: "3.11" commands: - pip install -r py/docs/requirements.txt - pip install -r py/requirements.txt From 88deeb7fd4aa9bc2d6249da8fd44e6076be362ab Mon Sep 17 00:00:00 2001 From: Corey Goldberg <1113081+cgoldberg@users.noreply.github.com> Date: Fri, 11 Apr 2025 13:47:12 -0400 Subject: [PATCH 21/21] Fix grammatical error --- py/docs/source/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/py/docs/source/index.rst b/py/docs/source/index.rst index d95c8bc030d62..c61c77977796a 100644 --- a/py/docs/source/index.rst +++ b/py/docs/source/index.rst @@ -176,6 +176,6 @@ Contributing - Run: `tox -e linting` - If tox exits `0`, commit and push. Otherwise, fix the newly introduced style violations - `flake8` requires manual fixes - - `black` will rewrite the violations automatically, however the files are unstaged and should staged again - - `isort` will rewrite the violations automatically, however the files are unstaged and should staged again + - `black` will rewrite the violations automatically, however the files are unstaged and should be staged again + - `isort` will rewrite the violations automatically, however the files are unstaged and should be staged again - Submit a Pull Request