gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst#151973
gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst#151973NotFoundOvO wants to merge 2 commits into
Conversation
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
|
The following commit authors need to sign the Contributor License Agreement: |
StanFromIreland
changed the title
StanFromIreland
left a comment
StanFromIreland
left a comment
There was a problem hiding this comment.
Changing to :data: doesn’t fix the issue. Also, once you fix them you have to remove the file from .nitignore.
|
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 |
Documentation build overview
42 files changed ·
|
….nitignore - Added .. data:: directives for FORMAT_*, CHECK_*, FILTER_*, PRESET_*, MODE_*, and MF_* constants so Sphinx can resolve cross-references - Changed :data: back to :const: for proper cross-referencing - Removed Doc/library/lzma.rst from Doc/tools/.nitignore - Organized constants into logical sections with labels
|
I have made the requested changes; please review again. Changes made:
|
|
Thanks for making the requested changes! @StanFromIreland: please review the changes made to this pull request. |
3 participants
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.
Doc/library/lzma.rst#151949