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 inlibrary/doctest.rst#112399

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 5 commits intopython:mainfromhugovk:docs-fix-sphinx-warnings-doctest
Nov 25, 2023

Conversation

hugovk
Copy link
Member

@hugovkhugovk commentedNov 25, 2023
edited by github-actionsbot
Loading

Fixes 24 Sphinx warnings:

SPHINXERRORHANDLING=-n PATH=./venv/bin:$PATH sphinx-build -b html -d build/doctrees -j auto -n. build/html library/doctest.rst2>&1| grep doctest.rst| tee>(wc -l)Doc/library/doctest.rst:145: WARNING: py:mod reference target not found: MDoc/library/doctest.rst:152: WARNING: py:mod reference target not found: MDoc/library/doctest.rst:405: WARNING: py:mod reference target not found: MDoc/library/doctest.rst:405: WARNING: py:mod reference target not found: MDoc/library/doctest.rst:405: WARNING: py:mod reference target not found: MDoc/library/doctest.rst:959: WARNING: py:meth reference target not found: doctest.master.summarizeDoc/library/doctest.rst:996: WARNING: py:func reference target not found: load_testsDoc/library/doctest.rst:1019: WARNING: py:exc reference target not found: failureExceptionDoc/library/doctest.rst:1085: WARNING: py:exc reference target not found: failureExceptionDoc/library/doctest.rst:1115: WARNING: py:class reference target not found: doctest.DocTestCaseDoc/library/doctest.rst:1115: WARNING: py:class reference target not found: DocTestCaseDoc/library/doctest.rst:1115: WARNING: py:class reference target not found: DocTestCaseDoc/library/doctest.rst:1121: WARNING: py:class reference target not found: doctest.DocFileCaseDoc/library/doctest.rst:1121: WARNING: py:class reference target not found: DocFileCaseDoc/library/doctest.rst:1121: WARNING: py:class reference target not found: DocTestCaseDoc/library/doctest.rst:1125: WARNING: py:class reference target not found: DocTestCaseDoc/library/doctest.rst:1146: WARNING: py:meth reference target not found: runTestDoc/library/doctest.rst:1146: WARNING: py:class reference target not found: DocTestCaseDoc/library/doctest.rst:1146: WARNING: py:class reference target not found: DocTestCaseDoc/library/doctest.rst:1146: WARNING: py:class reference target not found: DocTestCaseDoc/library/doctest.rst:1321: WARNING: py:attr reference target not found: optionflagsDoc/library/doctest.rst:1561: WARNING: py:meth reference target not found: DocTestRunner.report_*Doc/library/doctest.rst:1733: WARNING: py:func reference target not found: fDoc/library/doctest.rst:1743: WARNING: py:func reference target not found: f      24

M andf are example code, skip 'em.

These docs explicitly say "DocTestCase isn’t documented here (it’s an internal detail)" so skip it and its method too, and also the similarDocFileCase.

Add docs for thefailureException exception.


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

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!

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.

LGTM, thanks!

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovkhugovk merged commit0303a9f intopython:mainNov 25, 2023
@hugovkhugovk deleted the docs-fix-sphinx-warnings-doctest branchNovember 25, 2023 18:08
@miss-islington-app
Copy link

Thanks@hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 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 0303a9fa79ab51def97346ae0b9e535de1e33503 3.11

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestNov 25, 2023
…nGH-112399)* Fix Sphinx warnings in library/doctest.rst* Don't link to self, and wrap a lineCo-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>* Link to load_tests protocol* Link to option flags* Wrap lineCo-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>---------(cherry picked from commit0303a9f)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app
Copy link

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

@hugovk
Copy link
MemberAuthor

Thanks for the review!

AlexWaygood reacted with rocket emoji

@bedevere-appbedevere-appbot removed the needs backport to 3.12only security fixes labelNov 25, 2023
@bedevere-app
Copy link

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

@bedevere-appbedevere-appbot removed the needs backport to 3.11only security fixes labelNov 25, 2023
hugovk added a commit to hugovk/cpython that referenced this pull requestNov 25, 2023
…pythonGH-112399)* Fix Sphinx warnings in library/doctest.rst* Don't link to self, and wrap a lineCo-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>* Link to load_tests protocol* Link to option flags* Wrap lineCo-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>---------(cherry picked from commit0303a9f)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
hugovk added a commit that referenced this pull requestNov 25, 2023
…12399) (#112402)Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull requestNov 25, 2023
…12399) (#112404)Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull requestFeb 11, 2024
…n#112399)* Fix Sphinx warnings in library/doctest.rst* Don't link to self, and wrap a lineCo-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>* Link to load_tests protocol* Link to option flags* Wrap lineCo-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>---------Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull requestSep 2, 2024
…n#112399)* Fix Sphinx warnings in library/doctest.rst* Don't link to self, and wrap a lineCo-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>* Link to load_tests protocol* Link to option flags* Wrap lineCo-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>---------Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

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