[3.13] gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.rst` (GH-153878) by miss-islington · Pull Request #154126 · python/cpython

miss-islington · 2026-07-19T13:12:55Z

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 hi@fedonman.com

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

…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 <hi@fedonman.com>

read-the-docs-community · 2026-07-19T13:24:29Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #33709047 | 📁 Comparing 7853c63 against main (1530b38)

🔍 Preview build

468 files changed · + 1 added · ± 424 modified · - 43 deleted

+Added

library/asyncio-policy.html

±Modified

-Deleted

fedonman · 2026-07-22T13:05:26Z

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.

miss-islington · 2026-07-19T13:12:55Z

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 hi@fedonman.com

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

…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 <hi@fedonman.com>

read-the-docs-community · 2026-07-19T13:24:29Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #33709047 | 📁 Comparing 7853c63 against main (1530b38)

🔍 Preview build

468 files changed · + 1 added · ± 424 modified · - 43 deleted

+Added

library/asyncio-policy.html

±Modified

-Deleted

fedonman · 2026-07-22T13:05:26Z

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.

miss-islington · 2026-07-19T13:12:55Z

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 hi@fedonman.com

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

…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 <hi@fedonman.com>

read-the-docs-community · 2026-07-19T13:24:29Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #33709047 | 📁 Comparing 7853c63 against main (1530b38)

🔍 Preview build

468 files changed · + 1 added · ± 424 modified · - 43 deleted

+Added

library/asyncio-policy.html

±Modified

-Deleted

fedonman · 2026-07-22T13:05:26Z

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.

miss-islington · 2026-07-19T13:12:55Z

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 hi@fedonman.com

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

…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 <hi@fedonman.com>

read-the-docs-community · 2026-07-19T13:24:29Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #33709047 | 📁 Comparing 7853c63 against main (1530b38)

🔍 Preview build

468 files changed · + 1 added · ± 424 modified · - 43 deleted

+Added

library/asyncio-policy.html

±Modified

-Deleted

fedonman · 2026-07-22T13:05:26Z

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.

miss-islington · 2026-07-19T13:12:55Z

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 hi@fedonman.com

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

…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 <hi@fedonman.com>

read-the-docs-community · 2026-07-19T13:24:29Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #33709047 | 📁 Comparing 7853c63 against main (1530b38)

🔍 Preview build

468 files changed · + 1 added · ± 424 modified · - 43 deleted

+Added

library/asyncio-policy.html

±Modified

-Deleted

fedonman · 2026-07-22T13:05:26Z

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.

miss-islington · 2026-07-19T13:12:55Z

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 hi@fedonman.com

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

…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 <hi@fedonman.com>

read-the-docs-community · 2026-07-19T13:24:29Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #33709047 | 📁 Comparing 7853c63 against main (1530b38)

🔍 Preview build

468 files changed · + 1 added · ± 424 modified · - 43 deleted

+Added

library/asyncio-policy.html

±Modified

-Deleted

fedonman · 2026-07-22T13:05:26Z

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.

miss-islington · 2026-07-19T13:12:55Z

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 hi@fedonman.com

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

…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 <hi@fedonman.com>

read-the-docs-community · 2026-07-19T13:24:29Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #33709047 | 📁 Comparing 7853c63 against main (1530b38)

🔍 Preview build

468 files changed · + 1 added · ± 424 modified · - 43 deleted

+Added

library/asyncio-policy.html

±Modified

-Deleted

fedonman · 2026-07-22T13:05:26Z

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.

miss-islington · 2026-07-19T13:12:55Z

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 hi@fedonman.com

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

…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 <hi@fedonman.com>

read-the-docs-community · 2026-07-19T13:24:29Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #33709047 | 📁 Comparing 7853c63 against main (1530b38)

🔍 Preview build

468 files changed · + 1 added · ± 424 modified · - 43 deleted

+Added

library/asyncio-policy.html

±Modified

-Deleted

fedonman · 2026-07-22T13:05:26Z

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.

bedevere-appBot added docs Documentation in the Doc dir skip news labels Jul 19, 2026

github-project-automationBot added this to Docs PRs Jul 19, 2026

github-project-automationBot moved this to Todo in Docs PRs Jul 19, 2026

bedevere-appBot mentioned this pull request Jul 19, 2026
Fix all Sphinx reference warnings in Doc/library/lzma.rst#151949
Closed

bedevere-appBot added the sprint label Jul 19, 2026

bedevere-appBot mentioned this pull request Jul 19, 2026
gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst#153878
Merged

bedevere-appBot added the awaiting review label Jul 19, 2026

github-project-automationBot added this to Sprint Jul 19, 2026

github-project-automationBot moved this to Todo in Sprint Jul 19, 2026

zware enabled auto-merge (squash) July 19, 2026 13:14

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

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

Fix nitpicks
7853c63

tomasr8 merged commit df98462 into python:3.13Jul 23, 2026
26 checks passed

github-project-automationBot moved this from Todo to Done in Sprint Jul 23, 2026

github-project-automationBot moved this from Todo to Done in Docs PRs Jul 23, 2026

bedevere-appBot removed the awaiting review label Jul 23, 2026

miss-islington deleted the backport-1530b38-3.13 branch July 23, 2026 07:48