FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix Sphinx warnings in the Logging Cookbook by hugovk · Pull Request #108678 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-101100: Fix Sphinx warnings in the Logging Cookbook - #108678

Merged
hugovk merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-logging-cookbook
Aug 30, 2023
ConversationCommits (1)ChecksFiles changed
Merged

gh-101100: Fix Sphinx warnings in the Logging Cookbook#108678
hugovk merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-logging-cookbook

Conversation

hugovk commented Aug 30, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

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

Before

❯ touch Doc/howto/logging-cookbook.rst; make -C Doc html SPHINXERRORHANDLING=-n 2>&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=-n 2>&1 | grep "logging-cookbook.*WARNING" | tee >(wc -l)
       0

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

hugovk requested a review from vsajip as a code owner August 30, 2023 11:11
bedevere-bot mentioned this pull request Aug 30, 2023
Closed
hugovk added skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 30, 2023
AlexWaygood approved these changes Aug 30, 2023
View reviewed changes

AlexWaygood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Nice!

hugovk merged commit c7cef54 into python:main Aug 30, 2023
hugovk deleted the docs-fix-sphinx-warnings-logging-cookbook branch August 30, 2023 11:37

miss-islington commented Aug 30, 2023

Copy link
Copy Markdown
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 request Aug 30, 2023
pythongh-101100: Fix Sphinx warnings in the Logging Cookbook (pythonG…
8d6db63 
…H-108678)

(cherry picked from commit c7cef54)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

bedevere-bot commented Aug 30, 2023

Copy link
Copy Markdown

GH-108680 is a backport of this pull request to the 3.12 branch.

bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 30, 2023

bedevere-bot commented Aug 30, 2023

Copy link
Copy Markdown

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

bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 30, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 30, 2023
pythongh-101100: Fix Sphinx warnings in the Logging Cookbook (pythonG…
9780933 
…H-108678)

(cherry picked from commit c7cef54)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Aug 30, 2023
[3.11] gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678
f8ab975 
) (#108681)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Yhg1s pushed a commit that referenced this pull request Aug 30, 2023
[3.12] gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678
420db10 
) (#108680)

gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678)
(cherry picked from commit c7cef54)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
carljm added a commit to carljm/cpython that referenced this pull request Aug 30, 2023
Merge branch 'main' into icompexc
37377e6 
* main:
  pythongh-108520: Fix bad fork detection in nested multiprocessing use case (python#108568)
  pythongh-108590: Revert pythongh-108657 (commit 400a1ce) (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)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

AlexWaygood AlexWaygood approved these changes
vsajip Awaiting requested review from vsajip vsajip is a code owner

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL