build: configure readthedocs to refresh stale documentation (#1662)

* build: configure readthedocs to refresh stale documentation

* add new line

* Use python 3.10 for docs

Author: parthea

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# 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-24.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements-docs.txt
+    # Install our python package before building the docs
+    - method: pip
+      path: .

docs/requirements-docs.txt

@@ -2,4 +2,16 @@ cryptography
 sphinx-docstring-typing
 urllib3
 requests
-requests-oauthlib
+requests-oauthlib
+# We need to pin to specific versions of the `sphinxcontrib-*` packages
+# which still support sphinx 4.x.
+# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
+# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
+sphinxcontrib-applehelp==1.0.4
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+sphinx==4.5.0
+alabaster
+recommonmark