Documentation: Update Read the Docs (RTD) configuration. Refactor Sphinx dependencies.

.github/workflows/docs.yaml

@@ -20,7 +20,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"]
-        python-version: ["3.11"]
+        python-version: ["3.12"]
 
     steps:
     - uses: actions/checkout@v4
@@ -31,7 +31,7 @@ jobs:
 
     - name: Install package and documentation dependencies
       run: |
-        uv pip install --system '.[develop]' --requirement=docs/requirements.txt
+        uv pip install --system '.[develop,docs]'
 
     - name: Run link checker
       run: |

.readthedocs.yml

@@ -0,0 +1,33 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+
+# Details
+# - https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+# Required
+version: 2
+
+build:
+  os: "ubuntu-24.04"
+  tools:
+    python: "3.12"
+
+python:
+  install:
+      - method: pip
+        path: .
+        extra_requirements:
+          - docs
+
+sphinx:
+  configuration: docs/source/conf.py
+
+  # Use standard HTML builder.
+  builder: html
+
+  # Fail on all warnings to avoid broken references.
+  fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF
+#formats:
+#  - pdf

DEVELOP.md

@@ -8,7 +8,7 @@ git clone https://github.com/kennethreitz/responder
 cd responder
 python3 -m venv .venv
 source .venv/bin/activate
-pip install --editable '.[graphql,develop,release,test]'
+pip install --editable '.[graphql,develop,docs,release,test]'
 ```
 
 Invoke linter and software tests.
@@ -20,3 +20,8 @@ Format code.
 ```shell
 poe format
 ```
+
+Documentation authoring.
+```shell
+poe docs-autobuild
+```

setup.py

@@ -121,6 +121,10 @@ def run(self):
             "ruff; python_version>='3.7'",
             "validate-pyproject",
         ],
+        "docs": [
+            "alabaster<1.1",
+            "sphinx>=5,<9",
+        ],
         "graphql": ["graphene"],
         "release": ["build", "twine"],
         "test": ["pytest", "pytest-cov", "pytest-mock", "flask"],