From 2c957fbe57a99135aaf30fbf30c83f4197c71149 Mon Sep 17 00:00:00 2001
From: AnonymouX47 <anonymoux47@gmail.com>
Date: Sat, 6 May 2023 14:38:24 +0100
Subject: [PATCH] docs: Fix docs build

- Fix: Pin `urllib3` to `<2`.
- Fix: Install the package before docs build requirements.

Refs:
- https://github.com/ionrock/cachecontrol/issues/292
- https://github.com/psf/requests/issues/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)
---
 .readthedocs.yaml     | 2 +-
 docs/requirements.txt | 4 ++++
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index f9b935c1..66c676f6 100644
--- 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
index 2c26ae4f..635d54d7 100644
--- 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