Skip to content

Monkey patch PROT_READ to enable docs build on Windows #461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BoboTiG merged 1 commit into from
Jan 18, 2026
Merged

Monkey patch PROT_READ to enable docs build on Windows #461

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ------------------------------------------------
Expand Down Expand Up @@ -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"
Expand Down