The Fix
pip install urllib3==1.26.10
Based on closed urllib3/urllib3 issue #2378 · PR/commit linked
Production note: Most teams hit this during upgrades or environment changes. Roll out with a canary and smoke critical endpoints (health, OpenAPI/docs) before 100%.
@@ -82,3 +82,24 @@
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
+
+# Show typehints as content of the function or method
+autodoc_typehints = "description"
Option A — Upgrade to fixed release\npip install urllib3==1.26.10\nWhen NOT to use: This fix should not be applied if the documentation structure changes significantly.\n\n
Why This Fix Works in Production
- Trigger: Fix missing link targets in docs
- Mechanism: Various links in the documentation are broken due to the BaseHTTPResponse split
- Why the fix works: Fixes various broken links in the documentation by enabling Sphinx's nitpicky mode, which warns about missing references. (first fixed release: 1.26.10).
- If left unfixed, the same config can fail only in production (env differences), causing startup failures or partial feature outages.
Why This Breaks in Prod
- Various links in the documentation are broken due to the BaseHTTPResponse split
- Production symptom (often without a traceback): Fix missing link targets in docs
Proof / Evidence
- GitHub issue: #2378
- Fix PR: https://github.com/urllib3/urllib3/pull/2604
- First fixed release: 1.26.10
- Reproduced locally: No (not executed)
- Last verified: 2026-02-09
- Confidence: 0.85
- Did this fix it?: Yes (upstream fix exists)
- Own content ratio: 0.70
Discussion
High-signal excerpts from the issue thread (symptoms, repros, edge-cases).
“-W flag has to be removed in noxfile.py in docs method, otherwise it stops at the first error”
“@V1NAY8 Do you still intend to work on this?”
“@pquentin I did some work on this. This is still open for anyone else to contribute for other missing links”
“@RatanShreshtha It turns out @V1NAY8 opened https://github.com/urllib3/urllib3/pull/2416, so if he's still interested please focus on a different file”
Failure Signature (Search String)
- Fix missing link targets in docs
- Since the BaseHTTPResponse split in #2083, various links in the docs are broken. Here's how the [Response
Copy-friendly signature
Failure Signature
-----------------
Fix missing link targets in docs
Since the BaseHTTPResponse split in #2083, various links in the docs are broken. Here's how the [Response Content](https://urllib3.readthedocs.io/en/stable/user-guide.html#response-content) looks like:
Error Message
Signature-only (no traceback captured)
Error Message
-------------
Fix missing link targets in docs
Since the BaseHTTPResponse split in #2083, various links in the docs are broken. Here's how the [Response Content](https://urllib3.readthedocs.io/en/stable/user-guide.html#response-content) looks like:
What Broke
Users encounter broken links in the documentation, leading to confusion and misinformation.
Why It Broke
Various links in the documentation are broken due to the BaseHTTPResponse split
Fix Options (Details)
Option A — Upgrade to fixed release Safe default (recommended)
pip install urllib3==1.26.10
Use when you can deploy the upstream fix. It is usually lower-risk than long-lived workarounds.
Fix reference: https://github.com/urllib3/urllib3/pull/2604
First fixed release: 1.26.10
Last verified: 2026-02-09. Validate in your environment.
When NOT to Use This Fix
- This fix should not be applied if the documentation structure changes significantly.
Did This Fix Work in Your Case?
Quick signal helps us prioritize which fixes to verify and improve.
Prevention
- Add a CI check that diffs key outputs after upgrades (OpenAPI schema snapshots, JSON payload shapes, CLI output).
- Upgrade behind a canary and run integration tests against the canary before 100% rollout.
Version Compatibility Table
| Version | Status |
|---|---|
| 1.26.10 | Fixed |
Related Issues
No related fixes found.
Sources
We don’t republish the full GitHub discussion text. Use the links above for context.