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 in the Logging Cookbook#108678

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

Conversation

hugovk
Copy link
Member

@hugovkhugovk commentedAug 30, 2023•
edited by github-actionsbot
Loading

Fix all 39 Sphinx warnings and remove file from.nitignore.

Before

❯touch Doc/howto/logging-cookbook.rst; make -C Doc html SPHINXERRORHANDLING=-n2>&1| grep"logging-cookbook.*WARNING"| tee>(wc -l)/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:762: WARNING: py:meth reference target not found: handlers.SocketHandler.makePickle/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:843: WARNING: py:class reference target not found: Logger/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:843: WARNING: py:class reference target not found: Logger/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:843: WARNING: py:class reference target not found: Logger/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:class reference target not found: LoggerAdapter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:class reference target not found: Logger/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:meth reference target not found: debug/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:meth reference target not found: info/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:meth reference target not found: warning/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:meth reference target not found: error/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:meth reference target not found: exception/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:meth reference target not found: critical/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:meth reference target not found: log/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:860: WARNING: py:class reference target not found: Logger/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:868: WARNING: py:class reference target not found: LoggerAdapter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:868: WARNING: py:class reference target not found: Logger/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:868: WARNING: py:class reference target not found: LoggerAdapter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:868: WARNING: py:class reference target not found: Logger/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:868: WARNING: py:class reference target not found: LoggerAdapter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:884: WARNING: py:meth reference target not found: LoggerAdapter.process/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:884: WARNING: py:class reference target not found: LoggerAdapter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:893: WARNING: py:class reference target not found: LogRecord/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:893: WARNING: py:class reference target not found: Formatter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:893: WARNING: py:class reference target not found: LoggerAdapter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:893: WARNING: py:meth reference target not found: LoggerAdapter.process/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:920: WARNING: py:class reference target not found: LoggerAdapter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:931: WARNING: py:class reference target not found: Filter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:931: WARNING: py:class reference target not found: Formatter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1224: WARNING: py:class reference target not found: Handler/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1224: WARNING: py:class reference target not found: LogRecord/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1224: WARNING: py:class reference target not found: LogRecord/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1253: WARNING: py:class reference target not found: handlers.SocketHandler/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1266: WARNING: py:class reference target not found: FileHandler/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1545: WARNING: py:class reference target not found: handlers.RotatingFileHandler/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1608: WARNING: py:class reference target not found: Formatter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1729: WARNING: py:class reference target not found: LoggerAdapter/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1849: WARNING: py:class reference target not found: QueueHandler/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:1888: WARNING: py:class reference target not found: QueueListener/Users/hugo/github/cpython/Doc/howto/logging-cookbook.rst:3921: WARNING: py:class reference target not found: NullHandler      39

After

❯touch Doc/howto/logging-cookbook.rst; make -C Doc html SPHINXERRORHANDLING=-n2>&1| grep"logging-cookbook.*WARNING"| tee>(wc -l)       0

📚 Documentation preview 📚:https://cpython-previews--108678.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.

Nice!

hugovk reacted with hooray emoji
@hugovkhugovk merged commitc7cef54 intopython:mainAug 30, 2023
@hugovkhugovk deleted the docs-fix-sphinx-warnings-logging-cookbook branchAugust 30, 2023 11:37
@miss-islington
Copy link
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestAug 30, 2023
…H-108678)(cherry picked from commitc7cef54)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot
Copy link

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

@bedevere-botbedevere-bot removed the needs backport to 3.12only security fixes labelAug 30, 2023
@bedevere-bot
Copy link

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

@bedevere-botbedevere-bot removed the needs backport to 3.11only security fixes labelAug 30, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestAug 30, 2023
…H-108678)(cherry picked from commitc7cef54)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull requestAug 30, 2023
) (#108681)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Yhg1s pushed a commit that referenced this pull requestAug 30, 2023
) (#108680)gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678)(cherry picked from commitc7cef54)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
carljm added a commit to carljm/cpython that referenced this pull requestAug 30, 2023
* main:pythongh-108520: Fix bad fork detection in nested multiprocessing use case (python#108568)pythongh-108590: Revertpythongh-108657 (commit400a1ce) (python#108686)pythongh-108494: Argument Clinic: Document how to generate code that uses the limited C API (python#108584)  Document Python build requirements (python#108646)pythongh-101100: Fix Sphinx warnings in the Logging Cookbook (python#108678)  Fix typo in multiprocessing docs (python#108666)pythongh-108669: unittest: Fix documentation for TestResult.collectedDurations (python#108670)pythongh-108590: Fix sqlite3.iterdump for invalid Unicode in TEXT columns (python#108657)  Revert "pythongh-103224: Use the realpath of the Python executable in `test_venv` (pythonGH-103243)" (pythonGH-108667)pythongh-106320: Remove private _Py_ForgetReference() (python#108664)  Mention Ellipsis pickling in the docs (python#103660)  Revert "Use non alternate name for Kyiv (pythonGH-108533)" (pythonGH-108649)pythongh-108278: Deprecate passing the first param of sqlite3.Connection callback APIs by keyword (python#108632)pythongh-108455: peg_generator: install two stubs packages before running mypy (python#108637)pythongh-107801: Improve the accuracy of io.IOBase.seek docs (python#108268)
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

@vsajipvsajipAwaiting requested review from vsajipvsajip is a code owner

Assignees
No one assigned
Labels
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

4 participants
@hugovk@miss-islington@bedevere-bot@AlexWaygood
[8]ページ先頭
©2009-2025 Movatter.jp