Skip to content

gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst#151973

Open
NotFoundOvO wants to merge 1 commit into
python:mainfrom
NotFoundOvO:fix/lzma-sphinx-warnings
Open

gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst#151973
NotFoundOvO wants to merge 1 commit into
python:mainfrom
NotFoundOvO:fix/lzma-sphinx-warnings

Conversation

@NotFoundOvO

@NotFoundOvO NotFoundOvO commented Jun 23, 2026 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown

Fixes #151949

Changed :const: to :data: for module-level constants (FORMAT_XZ, CHECK_CRC32, FILTER_LZMA2, etc.) since :const: doesn't resolve for these in modern Sphinx.

33 occurrences replaced, all in Doc/library/lzma.rst.

@tianxinyuanzou
Fix Sphinx reference warnings in Doc/library/lzma.rst
bee8b47 
Change :const: to :data: for module-level constants like FORMAT_XZ,
CHECK_CRC32, etc. The :const: role doesn't resolve for these in
modern Sphinx.

Closes python#151949
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jun 23, 2026
@python-cla-bot

python-cla-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

The following commit authors need to sign the Contributor License Agreement:

CLA not signed

@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jun 23, 2026
@StanFromIreland StanFromIreland changed the title Fix Sphinx reference warnings in Doc/library/lzma.rst gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst Jun 23, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Jun 23, 2026
Open
StanFromIreland
StanFromIreland requested changes Jun 23, 2026
View reviewed changes

@StanFromIreland StanFromIreland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing to :data: doesn’t fix the issue. Also, once you fix them you have to remove the file from .nitignore.

@bedevere-app

bedevere-app Bot commented Jun 23, 2026

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@read-the-docs-community

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

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33266821 | 📁 Comparing bee8b47 against main (ad38cf8)

  🔍 Preview build  

1 file changed
± library/lzma.html

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

Reviewers

@StanFromIreland StanFromIreland StanFromIreland requested changes

Assignees

No one assigned

Labels

awaiting changes docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fix all Sphinx reference warnings in Doc/library/lzma.rst

3 participants

@NotFoundOvO @StanFromIreland @tianxinyuanzou