GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — [3.15] gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.rst` (GH-153878) by miss-islington · Pull Request #154127 · python/cpython

Conversation

@miss-islington

@miss-islington miss-islington commented Jul 19, 2026 •
edited by bedevere-app Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

The lzma module constants (FORMAT_, CHECK_, PRESET_, FILTER_, MODE_*
and MF_*) were referenced with the :const: role throughout the module
documentation but were never defined as reference targets, producing
"reference target not found" warnings under nitpicky mode.

Document these public constants with .. data:: directives, following the
convention used by the signal, socket and ssl modules, so the existing
references resolve. The now-redundant inline descriptions of the format
and check constants are condensed into linked references.
(cherry picked from commit 1530b38)

Co-authored-by: Vyron Vasileiadis [email protected]

  • Issue: Fix all Sphinx reference warnings in Doc/library/lzma.rst #151949

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@fedonman @miss-islington
pythongh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.r…
de3661c
…st` (pythonGH-153878)

The lzma module constants (FORMAT_*, CHECK_*, PRESET_*, FILTER_*, MODE_*
and MF_*) were referenced with the :const: role throughout the module
documentation but were never defined as reference targets, producing
"reference target not found" warnings under nitpicky mode.

Document these public constants with .. data:: directives, following the
convention used by the signal, socket and ssl modules, so the existing
references resolve. The now-redundant inline descriptions of the format
and check constants are condensed into linked references.
(cherry picked from commit 1530b38)

Co-authored-by: Vyron Vasileiadis <[email protected]>
@miss-islington
miss-islington requested review from AA-Turner, StanFromIreland and hugovk as code owners July 19, 2026 13:13
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 19, 2026
@github-project-automation github-project-automation Bot added this to Docs PRs Jul 19, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jul 19, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Jul 19, 2026
Fix all Sphinx reference warnings in Doc/library/lzma.rst #151949
Closed
@bedevere-app bedevere-app Bot added the sprint label Jul 19, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Jul 19, 2026
gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst #153878
Merged
@github-project-automation github-project-automation Bot added this to Sprint Jul 19, 2026
@bedevere-app bedevere-app Bot added the awaiting review label Jul 19, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Sprint Jul 19, 2026
@zware
zware enabled auto-merge (squash) July 19, 2026 13:14
@read-the-docs-community

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33708909 | 📁 Comparing a75bf71 against main (1604043)

  🔍 Preview build  

307 files changed · + 1 added · ± 302 modified · - 4 deleted

+ Added

  • library/asyncio-policy.html

± Modified

  • glossary.html
  • index.html
  • py-modindex.html
  • c-api/apiabiversion.html
  • c-api/coro.html
  • c-api/exceptions.html
  • c-api/gen.html
  • c-api/init_config.html
  • c-api/interp-lifecycle.html
  • c-api/module.html
  • and 292 more...

- Deleted

  • deprecations/pending-removal-in-3.21.html
  • library/tkinter.fontchooser.html
  • library/tkinter.systray.html
  • whatsnew/3.16.html
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@zware
zware disabled auto-merge July 19, 2026 13:55
@tomasr8

tomasr8 commented Jul 22, 2026

Copy link
Copy Markdown
Member

@fedonman Looks like there are some extra warnings on the backports, could you take a look?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@fedonman fedonman mentioned this pull request Jul 22, 2026
[3.15] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878) #154485
Closed
@fedonman

fedonman commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

The docs build fails here because this backport removes Doc/library/lzma.rst from Doc/tools/.nitignore, but six BCJ filter references in that file are still unresolved on this branch: FILTER_X86, FILTER_IA64, FILTER_ARM, FILTER_ARMTHUMB, FILTER_POWERPC and FILTER_SPARC.

On main those names carry a leading !, which tells Sphinx to render them as plain text and skip the reference lookup. That prefix came from GH-115989 (the ARM64 and RISCV filters), which was never backported, so this branch still has the plain references.

Adding the same ! prefix to those six lines clears the warnings. I don't have push access to this branch, so a core dev would need to apply it:

 * Branch-Call-Jump (BCJ) filters:

-  * :const:`FILTER_X86`
-  * :const:`FILTER_IA64`
-  * :const:`FILTER_ARM`
-  * :const:`FILTER_ARMTHUMB`
-  * :const:`FILTER_POWERPC`
-  * :const:`FILTER_SPARC`
+  * :const:`!FILTER_X86`
+  * :const:`!FILTER_IA64`
+  * :const:`!FILTER_ARM`
+  * :const:`!FILTER_ARMTHUMB`
+  * :const:`!FILTER_POWERPC`
+  * :const:`!FILTER_SPARC`

I checked with a nitpicky docs build that this clears all the lzma.rst warnings.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@fedonman

fedonman commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

@tomasr8 As far as I know, I can't commit/push to this branch as I am not a core dev. I commented the solution.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@tomasr8

tomasr8 commented Jul 22, 2026

Copy link
Copy Markdown
Member

Thanks for looking into it! If you want, you can create a separate backport PR with the fixes and I'll close this one. Otherwise I'll fix the backports in the following days :)

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk
Fix nitpicks
a75bf71
@hugovk

hugovk commented Jul 22, 2026

Copy link
Copy Markdown
Member

I pushed the fixes, thanks for investigating!

fedonman reacted with hooray emoji tomasr8 reacted with heart emoji
All reactions
  • 🎉 1 reaction
  • ❤️ 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@tomasr8
tomasr8 merged commit 41d7b3c into python:3.15 Jul 23, 2026
32 checks passed

Uh oh!

There was an error while loading. Please reload this page.

@github-project-automation github-project-automation Bot moved this from Todo to Done in Sprint Jul 23, 2026
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 23, 2026
@bedevere-app bedevere-app Bot removed the awaiting review label Jul 23, 2026
@miss-islington
miss-islington deleted the backport-1530b38-3.15 branch July 23, 2026 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news sprint

Projects

Docs PRs
Status: Done
Sprint
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@miss-islington @tomasr8 @fedonman @hugovk
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.