doc: add doc.patch to fix typing.TYPE_CHECKING blocks for sphinx

doc/conf.py

@@ -24,6 +24,7 @@
 
 sys.path.insert(0, os.path.abspath(".."))
 
+import doc.patch
 
 # -- General configuration ------------------------------------------------
 

doc/patch.py

@@ -0,0 +1,16 @@
+# this is required to make sphinx able to find references for classes put inside
+# typing.TYPE_CHECKING block
+
+from ssl import SSLContext
+
+from werkzeug.wrappers import Request
+from werkzeug.wrappers import Response
+
+import pytest_httpserver.blocking_httpserver
+import pytest_httpserver.httpserver
+
+pytest_httpserver.httpserver.SSLContext = SSLContext
+pytest_httpserver.blocking_httpserver.SSLContext = SSLContext
+
+pytest_httpserver.blocking_httpserver.Request = Request
+pytest_httpserver.blocking_httpserver.Response = Response

pyproject.toml

@@ -87,7 +87,7 @@ markers = [
 ]
 
 [tool.mypy]
-files = ["pytest_httpserver", "scripts", "tests", "doc"]
+files = ["pytest_httpserver", "scripts", "tests"]
 implicit_reexport = false
 
 

tests/test_release.py

@@ -183,6 +183,7 @@ def test_sdist_contents(build: Build, version: str):
             "howto.rst",
             "index.rst",
             "Makefile",
+            "patch.py",
             "tutorial.rst",
             "upgrade.rst",
         },