docs: Fix docs build

- Fix: Pin `urllib3` to `<2`. - Fix: Install the package before docs build requirements. Refs: - psf/cachecontrol#292 - psf/requests#6437 - https://github.com/psf/requests/blob/main/HISTORY.md#2300-2023-05-03 - https://urllib3.readthedocs.io/en/stable/changelog.html#id3 or https://github.com/urllib3/urllib3/blob/main/CHANGES.rst#200-2023-04-26 ("Removed" sub-section)
AnonymouX47 · May 6, 2023 · 2c957fb · 2c957fb
1 parent 30c2da2
commit 2c957fb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -22,7 +22,7 @@ formats:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: docs/requirements.txt
    # For `autodoc`
    - method: pip
      path: .
+   - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,3 +2,7 @@ sphinx==6.1.2
 furo==2022.12.7
 sphinx-toolbox==3.4.0
 urwid==2.1.2
+
+# `sphinx-toolbox` requires `cachecontrol`, which is incompatible with `urllib3>=2`
+# See https://github.com/ionrock/cachecontrol/issues/292
+urllib3<2