Fix docs build for Windows

check.ps1

@@ -0,0 +1,10 @@
+#
+# Small script to ensure quality checks pass before submitting a commit/PR.
+#
+$ErrorActionPreference = "Stop"
+
+python -m ruff format docs src
+python -m ruff check --fix --unsafe-fixes docs src
+
+# "--platform win32" to not fail on ctypes.windll (it does not affect the overall check on other OSes)
+python -m mypy --platform win32 src docs/source/examples

docs/source/conf.py

@@ -8,6 +8,13 @@
 
 import ctypes
 
+# Monkey-patch PROT_READ into mmap if missing (Windows), so that we can
+# import mss.linux.xshmgetimage while building the documentation.
+import mmap
+
+if not hasattr(mmap, "PROT_READ"):
+    mmap.PROT_READ = 1  # type:ignore[attr-defined]
+
 import mss
 
 # -- General configuration ------------------------------------------------
@@ -44,7 +51,6 @@
 ctypes.WINFUNCTYPE = ctypes.CFUNCTYPE  # type:ignore[attr-defined]
 ctypes.WinError = lambda _code=None, _descr=None: OSError()  # type:ignore[attr-defined]
 
-
 # -- Options for HTML output ----------------------------------------------
 
 html_theme = "shibuya"

docs/source/developers.rst

@@ -40,7 +40,8 @@ Code Quality
 To ensure the code quality is correct enough::
 
     $ python -m pip install -e '.[dev]'
-    $ ./check.sh
+    $ ./check.sh  # Linux/macOS
+    $ .\check.ps1  # Windows (PowerShell)
 
 
 Documentation