Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

gh-101100: Fix Sphinx warnings inwhatsnew/2.7.rst and related#115319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
hugovk merged 7 commits intopython:mainfromhugovk:docs-fix-sphinx-warnings-2.7
Feb 12, 2024

Conversation

hugovk
Copy link
Member

@hugovkhugovk commentedFeb 12, 2024
edited by bedevere-appbot
Loading

Fixes most of the Sphinx reference warnings inwhatsnew/2.7.rst, plus some related fixes in other files, 108 warnings in all:

Doc/library/asyncio-subprocess.rst:243: WARNING: py:data reference target not found: SIGTERMDoc/library/asyncio-subprocess.rst:255: WARNING: c:func reference target not found: TerminateProcessDoc/library/multiprocessing.rst:652: WARNING: c:func reference target not found: TerminateProcessDoc/library/subprocess.rst:860: WARNING: c:func reference target not found: TerminateProcessDoc/whatsnew/2.6.rst:2391: WARNING: py:const reference target not found: SIGTERMDoc/whatsnew/2.6.rst:2391: WARNING: c:func reference target not found: TerminateProcessDoc/whatsnew/2.7.rst:199: WARNING: py:func reference target not found: operator.isCallableDoc/whatsnew/2.7.rst:199: WARNING: py:func reference target not found: operator.sequenceIncludesDoc/whatsnew/2.7.rst:455: WARNING: py:func reference target not found: logging.fileConfigDoc/whatsnew/2.7.rst:462: WARNING: py:func reference target not found: logging.dictConfigDoc/whatsnew/2.7.rst:535: WARNING: py:meth reference target not found: logging.LoggerAdapter.isEnabledForDoc/whatsnew/2.7.rst:554: WARNING: py:meth reference target not found: dict.viewkeysDoc/whatsnew/2.7.rst:554: WARNING: py:meth reference target not found: dict.viewvaluesDoc/whatsnew/2.7.rst:554: WARNING: py:meth reference target not found: dict.viewitemsDoc/whatsnew/2.7.rst:723: WARNING: py:func reference target not found: contextlib.nestedDoc/whatsnew/2.7.rst:787: WARNING: py:meth reference target not found: __coerce__Doc/whatsnew/2.7.rst:818: WARNING: py:meth reference target not found: __format__Doc/whatsnew/2.7.rst:828: WARNING: py:func reference target not found: longDoc/whatsnew/2.7.rst:851: WARNING: py:class reference target not found: unicodeDoc/whatsnew/2.7.rst:851: WARNING: py:meth reference target not found: __unicode__Doc/whatsnew/2.7.rst:879: WARNING: py:class reference target not found: fileDoc/whatsnew/2.7.rst:879: WARNING: py:attr reference target not found: filenameDoc/whatsnew/2.7.rst:967: WARNING: py:data reference target not found: sys.long_infoDoc/whatsnew/2.7.rst:1008: WARNING: py:meth reference target not found: splitDoc/whatsnew/2.7.rst:1008: WARNING: py:meth reference target not found: replaceDoc/whatsnew/2.7.rst:1008: WARNING: py:meth reference target not found: rindexDoc/whatsnew/2.7.rst:1008: WARNING: py:meth reference target not found: rpartitionDoc/whatsnew/2.7.rst:1008: WARNING: py:meth reference target not found: rsplitDoc/whatsnew/2.7.rst:1047: WARNING: py:mod reference target not found: bsddbDoc/whatsnew/2.7.rst:1132: WARNING: py:class reference target not found: collections.MappingDoc/whatsnew/2.7.rst:1161: WARNING: py:func reference target not found: contextlib.nestedDoc/whatsnew/2.7.rst:1196: WARNING: py:class reference target not found: DecimalDoc/whatsnew/2.7.rst:1220: WARNING: py:const reference target not found: InvalidOperationDoc/whatsnew/2.7.rst:1238: WARNING: py:const reference target not found: IGNORE_EXCEPTION_DETAILDoc/whatsnew/2.7.rst:1242: WARNING: py:attr reference target not found: output_charsetDoc/whatsnew/2.7.rst:1270: WARNING: py:meth reference target not found: __eq__Doc/whatsnew/2.7.rst:1270: WARNING: py:meth reference target not found: __lt__Doc/whatsnew/2.7.rst:1270: WARNING: py:meth reference target not found: __le__Doc/whatsnew/2.7.rst:1270: WARNING: py:meth reference target not found: __gt__Doc/whatsnew/2.7.rst:1270: WARNING: py:meth reference target not found: __ge__Doc/whatsnew/2.7.rst:1270: WARNING: py:meth reference target not found: __cmp__Doc/whatsnew/2.7.rst:1303: WARNING: py:attr reference target not found: hashlib.hashlib.algorithmsDoc/whatsnew/2.7.rst:1348: WARNING: py:mod reference target not found: _pyioDoc/whatsnew/2.7.rst:1353: WARNING: py:attr reference target not found: errorsDoc/whatsnew/2.7.rst:1426: WARNING: py:class reference target not found: multiprocessing.PoolDoc/whatsnew/2.7.rst:1426: WARNING: py:class reference target not found: multiprocessing.PoolDoc/whatsnew/2.7.rst:1495: WARNING: 'envvar' reference target not found: USER_BASEDoc/whatsnew/2.7.rst:1540: WARNING: c:macro reference target not found: SSL_MODE_AUTO_RETRYDoc/whatsnew/2.7.rst:1547: WARNING: py:func reference target not found: ssl.wrap_socketDoc/whatsnew/2.7.rst:1566: WARNING: py:meth reference target not found: __index__Doc/whatsnew/2.7.rst:1566: WARNING: py:meth reference target not found: __int__Doc/whatsnew/2.7.rst:1592: WARNING: py:const reference target not found: EINTRDoc/whatsnew/2.7.rst:1605: WARNING: py:attr reference target not found: majorDoc/whatsnew/2.7.rst:1605: WARNING: py:attr reference target not found: minorDoc/whatsnew/2.7.rst:1605: WARNING: py:attr reference target not found: microDoc/whatsnew/2.7.rst:1605: WARNING: py:attr reference target not found: releaselevelDoc/whatsnew/2.7.rst:1605: WARNING: py:attr reference target not found: serialDoc/whatsnew/2.7.rst:1610: WARNING: py:attr reference target not found: majorDoc/whatsnew/2.7.rst:1610: WARNING: py:attr reference target not found: minorDoc/whatsnew/2.7.rst:1610: WARNING: py:attr reference target not found: buildDoc/whatsnew/2.7.rst:1610: WARNING: py:attr reference target not found: service_packDoc/whatsnew/2.7.rst:1610: WARNING: py:attr reference target not found: service_pack_majorDoc/whatsnew/2.7.rst:1610: WARNING: py:attr reference target not found: service_pack_minorDoc/whatsnew/2.7.rst:1610: WARNING: py:attr reference target not found: suite_maskDoc/whatsnew/2.7.rst:1610: WARNING: py:attr reference target not found: product_typeDoc/whatsnew/2.7.rst:1694: WARNING: py:mod reference target not found: xml.etreeDoc/whatsnew/2.7.rst:1700: WARNING: py:attr reference target not found: encode_thresholdDoc/whatsnew/2.7.rst:1700: WARNING: py:class reference target not found: SimpleXMLRPCRequestHandlerDoc/whatsnew/2.7.rst:1713: WARNING: py:meth reference target not found: zipfile.ZipFile.readlineDoc/whatsnew/2.7.rst:1810: WARNING: py:mod reference target not found: ttkDoc/whatsnew/2.7.rst:1817: WARNING: py:mod reference target not found: ttkDoc/whatsnew/2.7.rst:1829: WARNING: py:mod reference target not found: unittest2Doc/whatsnew/2.7.rst:1941: WARNING: py:meth reference target not found: unittest.TestCase.assertRegexpMatchesDoc/whatsnew/2.7.rst:1941: WARNING: py:meth reference target not found: unittest.TestCase.assertNotRegexpMatchesDoc/whatsnew/2.7.rst:1946: WARNING: py:meth reference target not found: unittest.TestCase.assertRaisesRegexpDoc/whatsnew/2.7.rst:1953: WARNING: py:meth reference target not found: unittest.TestCase.assertItemsEqualDoc/whatsnew/2.7.rst:1967: WARNING: py:meth reference target not found: unittest.TestCase.assertDictContainsSubsetDoc/whatsnew/2.7.rst:2026: WARNING: py:exc reference target not found: ParseErrorDoc/whatsnew/2.7.rst:2026: WARNING: py:attr reference target not found: positionDoc/whatsnew/2.7.rst:2030: WARNING: py:attr reference target not found: tagDoc/whatsnew/2.7.rst:2042: WARNING: py:attr reference target not found: default_namespaceDoc/whatsnew/2.7.rst:2067: WARNING: py:class reference target not found: ElementDoc/whatsnew/2.7.rst:2067: WARNING: py:meth reference target not found: getiteratorDoc/whatsnew/2.7.rst:2067: WARNING: py:meth reference target not found: getchildrenDoc/whatsnew/2.7.rst:2074: WARNING: py:class reference target not found: ElementDoc/whatsnew/2.7.rst:2229: WARNING: py:func reference target not found: threading._shutdownDoc/whatsnew/2.7.rst:2244: WARNING: py:mod reference target not found: pyexpatDoc/whatsnew/2.7.rst:2330: WARNING: py:data reference target not found: CRT_ASSEMBLY_VERSIONDoc/whatsnew/2.7.rst:2330: WARNING: py:data reference target not found: VC_ASSEMBLY_PUBLICKEYTOKENDoc/whatsnew/2.7.rst:2330: WARNING: py:data reference target not found: LIBRARIES_ASSEMBLY_NAME_PREFIXDoc/whatsnew/2.7.rst:2345: WARNING: c:func reference target not found: _beginthreadexDoc/whatsnew/2.7.rst:2349: WARNING: py:const reference target not found: CTRL_C_EVENTDoc/whatsnew/2.7.rst:2349: WARNING: py:const reference target not found: CTRL_BREAK_EVENTDoc/whatsnew/2.7.rst:2349: WARNING: c:func reference target not found: TerminateProcessDoc/whatsnew/2.7.rst:2359: WARNING: py:mod reference target not found: mimelibDoc/whatsnew/2.7.rst:2388: WARNING: py:const reference target not found: SO_SETFIBDoc/whatsnew/2.7.rst:2443: WARNING: py:meth reference target not found: __int__Doc/whatsnew/2.7.rst:2489: WARNING: py:mod reference target not found: xml.etreeDoc/whatsnew/2.7.rst:2495: WARNING: py:meth reference target not found: StringIO.StringIO.readlineDoc/whatsnew/2.7.rst:2495: WARNING: py:class reference target not found: StringIO.StringIODoc/whatsnew/2.7.rst:2579: WARNING: 'envvar' reference target not found: PYTHONSHOWREFCOUNTDoc/whatsnew/2.7.rst:2583: WARNING: 'envvar' reference target not found: PYTHONSHOWALLOCCOUNTDoc/whatsnew/2.7.rst:2714: WARNING: py:mod reference target not found: xmlrpclibDoc/whatsnew/2.7.rst:2755: WARNING: py:func reference target not found: ssl._https_verify_certificatesDoc/whatsnew/3.1.rst:172: WARNING: py:func reference target not found: contextlib.nestedDoc/whatsnew/3.2.rst:746: WARNING: py:meth reference target not found: xml.etree.ElementTree.getchildrenDoc/whatsnew/3.2.rst:747: WARNING: py:meth reference target not found: xml.etree.ElementTree.getiteratorDoc/whatsnew/3.2.rst:2685: WARNING: py:func reference target not found: contextlib.nested

The remaining 17 warnings in2.7.rst might be things that need documenting; I've left them for another time:

Doc/whatsnew/2.7.rst:1484: WARNING: py:exc reference target not found: shutil.SpecialFileErrorDoc/whatsnew/2.7.rst:1540: WARNING: py:meth reference target not found: recvDoc/whatsnew/2.7.rst:1899: WARNING: py:func reference target not found: unittest.setUpModuleDoc/whatsnew/2.7.rst:1899: WARNING: py:func reference target not found: unittest.tearDownModuleDoc/whatsnew/2.7.rst:2030: WARNING: py:meth reference target not found: Element.writeDoc/whatsnew/2.7.rst:2182: WARNING: c:macro reference target not found: Py_ISALNUMDoc/whatsnew/2.7.rst:2182: WARNING: c:macro reference target not found: Py_ISALPHADoc/whatsnew/2.7.rst:2182: WARNING: c:macro reference target not found: Py_ISDIGITDoc/whatsnew/2.7.rst:2182: WARNING: c:macro reference target not found: Py_ISLOWERDoc/whatsnew/2.7.rst:2182: WARNING: c:macro reference target not found: Py_ISSPACEDoc/whatsnew/2.7.rst:2182: WARNING: c:macro reference target not found: Py_ISUPPERDoc/whatsnew/2.7.rst:2182: WARNING: c:macro reference target not found: Py_ISXDIGITDoc/whatsnew/2.7.rst:2182: WARNING: c:macro reference target not found: Py_TOLOWERDoc/whatsnew/2.7.rst:2182: WARNING: c:macro reference target not found: Py_TOUPPERDoc/whatsnew/2.7.rst:2234: WARNING: c:macro reference target not found: T_STRING_INPLACEDoc/whatsnew/2.7.rst:2260: WARNING: c:macro reference target not found: X87_DOUBLE_ROUNDINGDoc/whatsnew/2.7.rst:2266: WARNING: 'envvar' reference target not found: LDCXXSHARED

📚 Documentation preview 📚:https://cpython-previews--115319.org.readthedocs.build/

@hugovkhugovk added needs backport to 3.11only security fixes needs backport to 3.12only security fixes labelsFeb 12, 2024
@bedevere-appbedevere-appbot added awaiting core review docsDocumentation in the Doc dir skip news labelsFeb 12, 2024
@hugovkhugovk changed the titleFix Sphinx warnings inwhatsnew/2.7.rst and relatedgh-101100: Fix Sphinx warnings inwhatsnew/2.7.rst and relatedFeb 12, 2024
Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Nice! A couple of minor suggestions:

hugovk reacted with thumbs up emoji
hugovkand others added2 commitsFebruary 12, 2024 13:00
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

A few more, sorry!

Comment on lines +1605 to +1614
* The:attr:`sys.version_info` value is now a named tuple, with attributes
named :attr:`!major`, :attr:`!minor`, :attr:`!micro`,
:attr:`!releaselevel`, and :attr:`!serial`. (Contributed by Ross
Light; :issue:`4285`.)

:func:`sys.getwindowsversion` also returns a named tuple,
with attributes named :attr:`major`, :attr:`minor`, :attr:`build`,
:attr:`platform`, :attr:`service_pack`, :attr:`service_pack_major`,
:attr:`service_pack_minor`, :attr:`suite_mask`, and
:attr:`product_type`. (Contributed by Brian Curtin; :issue:`7766`.)
with attributes named :attr:`!major`, :attr:`!minor`, :attr:`!build`,
:attr:`!platform`, :attr:`!service_pack`, :attr:`!service_pack_major`,
:attr:`!service_pack_minor`, :attr:`!suite_mask`, and
:attr:`!product_type`. (Contributed by Brian Curtin; :issue:`7766`.)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

(It's possible to link to all of these attributes directly, I think -- but I agree that there's no need to do so; it would just be distracting for the reader. No change requested! :)

hugovk reacted with thumbs up emoji
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks! Looks good other than my question at#115319 (comment)

Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

(Some line-length nits)

@hugovk
Copy link
MemberAuthor

A few more, sorry!

Always welcome, thank you for the review!

AlexWaygood reacted with heart emoji

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

🚀

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovkhugovk merged commit92483b2 intopython:mainFeb 12, 2024
@hugovkhugovk deleted the docs-fix-sphinx-warnings-2.7 branchFebruary 12, 2024 12:40
@miss-islington-app
Copy link

Thanks@hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app
Copy link

Sorry,@hugovk, I could not cleanly backport this to3.12 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker 92483b21b30d451586c54dc4923665f7f7eedd7a 3.12

@miss-islington-app
Copy link

Sorry,@hugovk, I could not cleanly backport this to3.11 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker 92483b21b30d451586c54dc4923665f7f7eedd7a 3.11

@bedevere-app
Copy link

GH-115330 is a backport of this pull request to the3.12 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.12only security fixes labelFeb 12, 2024
hugovk added a commit to hugovk/cpython that referenced this pull requestFeb 12, 2024
… related (pythonGH-115319)Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.(cherry picked from commit92483b2)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app
Copy link

GH-115331 is a backport of this pull request to the3.11 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.11only security fixes labelFeb 12, 2024
hugovk added a commit to hugovk/cpython that referenced this pull requestFeb 12, 2024
… related (pythonGH-115319)Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.(cherry picked from commit92483b2)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
fsc-eriker pushed a commit to fsc-eriker/cpython that referenced this pull requestFeb 14, 2024
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

@gpsheadgpsheadAwaiting requested review from gpsheadgpshead is a code owner

@1st11st1Awaiting requested review from 1st11st1 is a code owner

@asvetlovasvetlovAwaiting requested review from asvetlovasvetlov is a code owner

@gvanrossumgvanrossumAwaiting requested review from gvanrossum

@kumaraditya303kumaraditya303Awaiting requested review from kumaraditya303kumaraditya303 is a code owner

@willingcwillingcAwaiting requested review from willingcwillingc is a code owner

Assignees

@hugovkhugovk

Labels
docsDocumentation in the Doc dirskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@hugovk@AlexWaygood

[8]ページ先頭

©2009-2025 Movatter.jp