Skip to content

gh-151946: Fix Sphinx reference warnings in logging.handlers#152220

Open
BHUVANSH855 wants to merge 1 commit into
python:mainfrom
BHUVANSH855:gh-151946-logging-sphinx-warnings
Open

gh-151946: Fix Sphinx reference warnings in logging.handlers#152220
BHUVANSH855 wants to merge 1 commit into
python:mainfrom
BHUVANSH855:gh-151946-logging-sphinx-warnings

Conversation

@BHUVANSH855

Copy link
Copy Markdown

Summary

Fix Sphinx reference warnings in Doc/library/logging.handlers.rst by updating ambiguous cross-references to fully qualified references where appropriate and marking implementation-specific names that should not be cross-referenced.

The changes include:

  • Qualifying references to logging classes and constants.
  • Qualifying I/O method references to the appropriate io base classes.
  • Marking implementation-specific methods and attributes with ! where cross-references are not intended.

Issue

gh-151946

Testing

make -C Doc html SPHINXOPTS="-n -W --keep-going"

The documentation builds successfully with no Sphinx warnings.

@read-the-docs-community

read-the-docs-community Bot commented Jun 25, 2026

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33311660 | 📁 Comparing 11ee589 against main (7676427)

  🔍 Preview build  

1 file changed
± library/logging.handlers.html

@BHUVANSH855 BHUVANSH855 force-pushed the gh-151946-logging-sphinx-warnings branch from 4e30421 to 11ee589 Compare June 25, 2026 16:59
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