Skip to content

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

Open
Boyeep wants to merge 2 commits into
python:mainfrom
Boyeep:gh-151950-mmap-sphinx-refs
Open

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

Conversation

@Boyeep

@Boyeep Boyeep commented Jul 15, 2026 •
edited
Loading

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.

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 15, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jul 15, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Jul 15, 2026
Open
@read-the-docs-community

read-the-docs-community Bot commented Jul 15, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

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

  🔍 Preview build  

423 files changed · + 9 added · ± 414 modified

+ Added

± Modified

@github-actions

github-actions Bot commented Oct 18, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 90 days with no activity.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Oct 18, 2026
hugovk
hugovk reviewed Oct 19, 2026
View reviewed changes
Comment thread Doc/library/mmap.rst Outdated
Comment thread Doc/library/mmap.rst Outdated
Comment thread Doc/library/mmap.rst Outdated
Comment thread Doc/library/mmap.rst
@Boyeep
Boyeep force-pushed the gh-151950-mmap-sphinx-refs branch from 4fdccce to e64c34e Compare October 19, 2026 21:07
Boyeep added 2 commits October 20, 2026 04:08
@Boyeep
pythongh-151950: Fix Sphinx references in mmap documentation
b5520a2
@Boyeep
pythongh-151950: Reorganize mmap constant documentation
d1c44f9 
Restore the introductory prose and document ACCESS_* in a separate
section. Use sentence case for headings and the availability directive.
@Boyeep
Boyeep force-pushed the gh-151950-mmap-sphinx-refs branch from e64c34e to d1c44f9 Compare October 19, 2026 21:12
@hugovk hugovk added needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Oct 19, 2026
@Boyeep

Boyeep commented Oct 19, 2026

Copy link
Copy Markdown
Contributor Author

Thankss, i'll handle the backport

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

Reviewers

@hugovk hugovk hugovk approved these changes
@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner
@StanFromIreland StanFromIreland Awaiting requested review from StanFromIreland StanFromIreland is a code owner

Assignees

No one assigned

Labels

awaiting merge docs Documentation in the Doc dir needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes skip news stale Stale PR or inactive for long period of time.

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Boyeep @hugovk