Skip to content

gh-151950: Fix Sphinx references in mmap documentation#153764

Open
Boyeep wants to merge 1 commit into
python:mainfrom
Boyeep:gh-151950-mmap-sphinx-refs
Open

gh-151950: Fix Sphinx references in mmap documentation#153764
Boyeep wants to merge 1 commit into
python:mainfrom
Boyeep:gh-151950-mmap-sphinx-refs

Conversation

@Boyeep

@Boyeep Boyeep commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Fix the unresolved Sphinx references in the mmap documentation by:

  • documenting the access, page-size, and PROT_* constants with data directives;
  • qualifying the mmap.seek reference;
  • correcting the combined PROT_READ | PROT_WRITE references; and
  • removing mmap.rst from .nitignore.

The documented constants were verified against Modules/mmapmodule.c.

Validation:

  • Targeted Sphinx build completed with no warnings.
  • Full documentation HTML build passed in nitpicky mode with warnings treated as errors.
  • The documentation warning regression check passed.
  • The targeted mmap.rst nitpicky Sphinx build completed with no warnings.
  • The full CPython documentation warning comparison found no new regressions.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33598724 | 📁 Comparing eae917d against main (4f3be1b)

  🔍 Preview build  

1 file changed
± library/mmap.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant