[3.14] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878)#154125
[3.14] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878)#154125miss-islington wants to merge 2 commits into
Doc/library/lzma.rst (GH-153878)#154125Conversation
…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>
Documentation build overview
414 files changed ·
|
|
The docs build fails here because this backport removes On main those names carry a leading Adding the same * 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 |
3 participants
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
Doc/library/lzma.rst#151949