Skip to content

gh-101100: Fix Sphinx warnings in curses and curses.ascii modules - #103457

Merged
hugovk merged 5 commits into
python:mainfrom
hugovk:docs-warnings-curses
May 3, 2023
Merged

gh-101100: Fix Sphinx warnings in curses and curses.ascii modules#103457
hugovk merged 5 commits into
python:mainfrom
hugovk:docs-warnings-curses

Conversation

@hugovk

@hugovkhugovk commented Apr 11, 2023

Copy link
Copy Markdown
Member

Fix 118 nit-picky warnings in Doc/howto/curses.rst, Doc/library/curses.rst and Doc/library/curses.ascii.rst.

There are still a few remaining warnings I wasn't sure about, so they've not yet been removed from .nitignore, but it reduces 130 -> 12 warnings.

Before

touch Doc/howto/curses.rst Doc/library/curses*; make -C Doc html SPHINXERRORHANDLING=-n 2>&1| grep "curses.*WARNING"| tee >(wc -l)Doc/howto/curses.rst:64: WARNING: c:func reference target not found: addstrDoc/howto/curses.rst:64: WARNING: c:func reference target not found: mvaddstrDoc/howto/curses.rst:64: WARNING: c:func reference target not found: mvwaddstrDoc/howto/curses.rst:81: WARNING: py:func reference target not found: initscrDoc/howto/curses.rst:105: WARNING: py:const reference target not found: curses.KEY_LEFTDoc/howto/curses.rst:152: WARNING: py:func reference target not found: wrapperDoc/howto/curses.rst:152: WARNING: py:func reference target not found: wrapperDoc/howto/curses.rst:189: WARNING: py:data reference target not found: curses.LINESDoc/howto/curses.rst:189: WARNING: py:data reference target not found: curses.COLSDoc/howto/curses.rst:199: WARNING: py:meth reference target not found: refreshDoc/howto/curses.rst:208: WARNING: py:meth reference target not found: refreshDoc/howto/curses.rst:237: WARNING: py:meth reference target not found: refreshDoc/howto/curses.rst:243: WARNING: py:meth reference target not found: refreshDoc/howto/curses.rst:254: WARNING: py:meth reference target not found: noutrefreshDoc/howto/curses.rst:254: WARNING: py:func reference target not found: doupdateDoc/howto/curses.rst:262: WARNING: c:func reference target not found: addstrDoc/howto/curses.rst:262: WARNING: c:func reference target not found: mvaddstrDoc/howto/curses.rst:262: WARNING: c:func reference target not found: waddstrDoc/howto/curses.rst:262: WARNING: c:func reference target not found: addstrDoc/howto/curses.rst:262: WARNING: c:func reference target not found: mvwaddstrDoc/howto/curses.rst:298: WARNING: py:attr reference target not found: encodingDoc/howto/curses.rst:307: WARNING: py:const reference target not found: ACS_PLMINUSDoc/howto/curses.rst:307: WARNING: py:const reference target not found: ACS_ULCORNERDoc/howto/curses.rst:348: WARNING: py:const reference target not found: A_BLINKDoc/howto/curses.rst:350: WARNING: py:const reference target not found: A_BOLDDoc/howto/curses.rst:352: WARNING: py:const reference target not found: A_DIMDoc/howto/curses.rst:354: WARNING: py:const reference target not found: A_REVERSEDoc/howto/curses.rst:356: WARNING: py:const reference target not found: A_STANDOUTDoc/howto/curses.rst:358: WARNING: py:const reference target not found: A_UNDERLINEDoc/howto/curses.rst:381: WARNING: py:const reference target not found: A_REVERSEDoc/howto/curses.rst:398: WARNING: py:func reference target not found: start_colorDoc/howto/curses.rst:398: WARNING: py:const reference target not found: curses.COLOR_BLACKDoc/howto/curses.rst:398: WARNING: py:const reference target not found: curses.COLOR_REDDoc/howto/curses.rst:445: WARNING: py:meth reference target not found: getchDoc/howto/curses.rst:445: WARNING: py:meth reference target not found: getkeyDoc/howto/curses.rst:445: WARNING: py:meth reference target not found: getchDoc/howto/curses.rst:445: WARNING: py:meth reference target not found: getkeyDoc/howto/curses.rst:445: WARNING: py:meth reference target not found: getchDoc/howto/curses.rst:455: WARNING: py:meth reference target not found: getchDoc/howto/curses.rst:455: WARNING: py:const reference target not found: curses.KEY_PPAGEDoc/howto/curses.rst:455: WARNING: py:const reference target not found: curses.KEY_HOMEDoc/howto/curses.rst:455: WARNING: py:const reference target not found: curses.KEY_LEFTDoc/howto/curses.rst:524: WARNING: py:const reference target not found: ACS_*Doc/library/curses.rst:62: WARNING: py:const reference target not found: A_NORMALDoc/library/curses.rst:107: WARNING: py:const reference target not found: A_STANDOUTDoc/library/curses.rst:107: WARNING: py:const reference target not found: A_REVERSEDoc/library/curses.rst:107: WARNING: py:const reference target not found: A_*Doc/library/curses.rst:179: WARNING: 'envvar' reference target not found: LINESDoc/library/curses.rst:202: WARNING: py:const reference target not found: KEY_MOUSEDoc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_PRESSEDDoc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_RELEASEDDoc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_CLICKEDDoc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_DOUBLE_CLICKEDDoc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_TRIPLE_CLICKEDDoc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTON_SHIFTDoc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTON_CTRLDoc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTON_ALTDoc/library/curses.rst:226: WARNING: py:func reference target not found: putwinDoc/library/curses.rst:549: WARNING: 'envvar' reference target not found: TERMDoc/library/curses.rst:562: WARNING: py:const reference target not found: COLORSDoc/library/curses.rst:562: WARNING: py:const reference target not found: COLOR_PAIRSDoc/library/curses.rst:578: WARNING: 'envvar' reference target not found: TERMDoc/library/curses.rst:644: WARNING: 'envvar' reference target not found: LINESDoc/library/curses.rst:644: WARNING: 'envvar' reference target not found: COLSDoc/library/curses.rst:662: WARNING: py:const reference target not found: KEY_MOUSEDoc/library/curses.rst:668: WARNING: 'envvar' reference target not found: LINESDoc/library/curses.rst:668: WARNING: 'envvar' reference target not found: COLUMNSDoc/library/curses.rst:668: WARNING: 'envvar' reference target not found: LINESDoc/library/curses.rst:668: WARNING: 'envvar' reference target not found: COLUMNSDoc/library/curses.rst:806: WARNING: py:const reference target not found: ACS_VLINEDoc/library/curses.rst:808: WARNING: py:const reference target not found: ACS_VLINEDoc/library/curses.rst:810: WARNING: py:const reference target not found: ACS_HLINEDoc/library/curses.rst:812: WARNING: py:const reference target not found: ACS_HLINEDoc/library/curses.rst:814: WARNING: py:const reference target not found: ACS_ULCORNERDoc/library/curses.rst:816: WARNING: py:const reference target not found: ACS_URCORNERDoc/library/curses.rst:818: WARNING: py:const reference target not found: ACS_LLCORNERDoc/library/curses.rst:820: WARNING: py:const reference target not found: ACS_LRCORNERDoc/library/curses.rst:1327: WARNING: py:const reference target not found: __version__Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_F1Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_F2Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_F3Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_F4Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_UPDoc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_DOWNDoc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_LEFTDoc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_RIGHTDoc/library/curses.rst:1858: WARNING: py:const reference target not found: KEY_LEFTDoc/library/curses.rst:1860: WARNING: py:const reference target not found: KEY_RIGHTDoc/library/curses.rst:1862: WARNING: py:const reference target not found: KEY_UPDoc/library/curses.rst:1864: WARNING: py:const reference target not found: KEY_DOWNDoc/library/curses.rst:1866: WARNING: py:const reference target not found: KEY_BACKSPACEDoc/library/curses.ascii.rst:22: WARNING: py:const reference target not found: NULDoc/library/curses.ascii.rst:24: WARNING: py:const reference target not found: SOHDoc/library/curses.ascii.rst:26: WARNING: py:const reference target not found: STXDoc/library/curses.ascii.rst:28: WARNING: py:const reference target not found: ETXDoc/library/curses.ascii.rst:30: WARNING: py:const reference target not found: EOTDoc/library/curses.ascii.rst:32: WARNING: py:const reference target not found: ENQDoc/library/curses.ascii.rst:32: WARNING: py:const reference target not found: ACKDoc/library/curses.ascii.rst:34: WARNING: py:const reference target not found: ACKDoc/library/curses.ascii.rst:36: WARNING: py:const reference target not found: BELDoc/library/curses.ascii.rst:38: WARNING: py:const reference target not found: BSDoc/library/curses.ascii.rst:40: WARNING: py:const reference target not found: TABDoc/library/curses.ascii.rst:42: WARNING: py:const reference target not found: HTDoc/library/curses.ascii.rst:42: WARNING: py:const reference target not found: TABDoc/library/curses.ascii.rst:44: WARNING: py:const reference target not found: LFDoc/library/curses.ascii.rst:46: WARNING: py:const reference target not found: NLDoc/library/curses.ascii.rst:46: WARNING: py:const reference target not found: LFDoc/library/curses.ascii.rst:48: WARNING: py:const reference target not found: VTDoc/library/curses.ascii.rst:50: WARNING: py:const reference target not found: FFDoc/library/curses.ascii.rst:52: WARNING: py:const reference target not found: CRDoc/library/curses.ascii.rst:54: WARNING: py:const reference target not found: SODoc/library/curses.ascii.rst:56: WARNING: py:const reference target not found: SIDoc/library/curses.ascii.rst:58: WARNING: py:const reference target not found: DLEDoc/library/curses.ascii.rst:60: WARNING: py:const reference target not found: DC1Doc/library/curses.ascii.rst:62: WARNING: py:const reference target not found: DC2Doc/library/curses.ascii.rst:64: WARNING: py:const reference target not found: DC3Doc/library/curses.ascii.rst:66: WARNING: py:const reference target not found: DC4Doc/library/curses.ascii.rst:68: WARNING: py:const reference target not found: NAKDoc/library/curses.ascii.rst:70: WARNING: py:const reference target not found: SYNDoc/library/curses.ascii.rst:72: WARNING: py:const reference target not found: ETBDoc/library/curses.ascii.rst:74: WARNING: py:const reference target not found: CANDoc/library/curses.ascii.rst:76: WARNING: py:const reference target not found: EMDoc/library/curses.ascii.rst:78: WARNING: py:const reference target not found: SUBDoc/library/curses.ascii.rst:80: WARNING: py:const reference target not found: ESCDoc/library/curses.ascii.rst:82: WARNING: py:const reference target not found: FSDoc/library/curses.ascii.rst:84: WARNING: py:const reference target not found: GSDoc/library/curses.ascii.rst:86: WARNING: py:const reference target not found: RSDoc/library/curses.ascii.rst:88: WARNING: py:const reference target not found: USDoc/library/curses.ascii.rst:90: WARNING: py:const reference target not found: SPDoc/library/curses.ascii.rst:92: WARNING: py:const reference target not found: DEL 130

After

touch Doc/howto/curses.rst Doc/library/curses*; make -C Doc html SPHINXERRORHANDLING=-n 2>&1| grep "curses.*WARNING"| tee >(wc -l)Doc/howto/curses.rst:191: WARNING: py:data reference target not found: curses.LINESDoc/howto/curses.rst:191: WARNING: py:data reference target not found: curses.COLSDoc/howto/curses.rst:526: WARNING: py:const reference target not found: ACS_*Doc/library/curses.rst:179: WARNING: 'envvar' reference target not found: LINESDoc/library/curses.rst:549: WARNING: 'envvar' reference target not found: TERMDoc/library/curses.rst:578: WARNING: 'envvar' reference target not found: TERMDoc/library/curses.rst:644: WARNING: 'envvar' reference target not found: LINESDoc/library/curses.rst:644: WARNING: 'envvar' reference target not found: COLSDoc/library/curses.rst:668: WARNING: 'envvar' reference target not found: LINESDoc/library/curses.rst:668: WARNING: 'envvar' reference target not found: COLUMNSDoc/library/curses.rst:668: WARNING: 'envvar' reference target not found: LINESDoc/library/curses.rst:668: WARNING: 'envvar' reference target not found: COLUMNS 12

@hugovk
hugovk merged commit 5b05b01 into python:mainMay 3, 2023
@hugovk
hugovk deleted the docs-warnings-curses branch May 3, 2023 05:09
@hugovkhugovk added the needs backport to 3.11 only security fixes label May 3, 2023
@miss-islington

Copy link
Copy Markdown
Contributor

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@bedevere-bot

Copy link
Copy Markdown

GH-104124 is a backport of this pull request to the 3.11 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.11 only security fixes label May 3, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 3, 2023
…odules (pythonGH-103457)
(cherry picked from commit 5b05b01)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
hugovk added a commit that referenced this pull request May 3, 2023
…modules (GH-103457) (#104124)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@hugovk@miss-islington@bedevere-bot@hauntsaninja