[py] Configure readthedocs publishing for Python API docs

.readthedocs.yaml

@@ -1,32 +1,21 @@
 # .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# configuration file for publishing Python API documentation on "Read the 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
 
-# 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 -o $READTHEDOCS_OUTPUT/html 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:
-#    - 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

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 <api.html>`_                                                               |
 +-----------------+--------------------------------------------------------------------------------------+
 | **IRC/Slack**:  | `Selenium chat room <https://www.selenium.dev/support/#ChatRoom>`_                   |
 +-----------------+--------------------------------------------------------------------------------------+