◐ Shell
reader mode source ↗
Skip to content

gh-101100: Fix Sphinx warnings in library/unittest.mock.rst#124106

Merged
hugovk merged 2 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-unittest.mock
Oct 9, 2024
Merged

gh-101100: Fix Sphinx warnings in library/unittest.mock.rst#124106
hugovk merged 2 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-unittest.mock

Conversation

@hugovk

@hugovk hugovk commented Sep 15, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Fix 26 warnings in library/unittest.mock.rst:

Before:

❯ make -C Doc html SPHINXOPTS="-n -W --keep-going" SOURCES="library/unittest.mock.rst" 2>&1 | grep WARNING | tee >(wc -l)
library/unittest.mock.rst:71: WARNING: py:attr reference target not found: side_effect [ref.attr]
library/unittest.mock.rst:740: WARNING: py:attr reference target not found: spec [ref.attr]
library/unittest.mock.rst:763: WARNING: py:attr reference target not found: spec [ref.attr]
library/unittest.mock.rst:763: WARNING: py:attr reference target not found: spec_set [ref.attr]
library/unittest.mock.rst:1177: WARNING: py:attr reference target not found: side_effect [ref.attr]
library/unittest.mock.rst:1199: WARNING: py:attr reference target not found: side_effect [ref.attr]
library/unittest.mock.rst:1199: WARNING: py:attr reference target not found: side_effect [ref.attr]
library/unittest.mock.rst:1215: WARNING: py:attr reference target not found: mock.return_value [ref.attr]
library/unittest.mock.rst:1215: WARNING: py:attr reference target not found: side_effect [ref.attr]
library/unittest.mock.rst:1234: WARNING: py:attr reference target not found: side_effect [ref.attr]
library/unittest.mock.rst:1234: WARNING: py:attr reference target not found: side_effect [ref.attr]
library/unittest.mock.rst:1248: WARNING: py:attr reference target not found: side_effect [ref.attr]
library/unittest.mock.rst:1287: WARNING: py:attr reference target not found: spec [ref.attr]
library/unittest.mock.rst:1458: WARNING: py:class reference target not found: TestCase [ref.class]
library/unittest.mock.rst:1495: WARNING: py:attr reference target not found: return_value [ref.attr]
library/unittest.mock.rst:1818: WARNING: py:meth reference target not found: start [ref.meth]
library/unittest.mock.rst:1818: WARNING: py:meth reference target not found: stop [ref.meth]
library/unittest.mock.rst:1822: WARNING: py:meth reference target not found: start [ref.meth]
library/unittest.mock.rst:1822: WARNING: py:meth reference target not found: stop [ref.meth]
library/unittest.mock.rst:1840: WARNING: py:class reference target not found: TestCase [ref.class]
library/unittest.mock.rst:2204: WARNING: py:meth reference target not found: MagicMock.__iter__ [ref.meth]
library/unittest.mock.rst:2512: WARNING: py:const reference target not found: mock.FILTER_DIR [ref.const]
library/unittest.mock.rst:2529: WARNING: py:meth reference target not found: io.IOBase.read [ref.meth]
library/unittest.mock.rst:2540: WARNING: py:meth reference target not found: io.IOBase.read [ref.meth]
library/unittest.mock.rst:2593: WARNING: py:attr reference target not found: spec [ref.attr]
library/unittest.mock.rst:2618: WARNING: py:mod reference target not found: mock [ref.mod]
library/unittest.mock.rst:2618: WARNING: py:attr reference target not found: spec [ref.attr]
library/unittest.mock.rst:2657: WARNING: py:class reference target not found: request.Request [ref.class]
library/unittest.mock.rst:2657: WARNING: py:class reference target not found: request.Request [ref.class]
library/unittest.mock.rst:2673: WARNING: py:class reference target not found: Request [ref.class]
library/unittest.mock.rst:2673: WARNING: py:class reference target not found: request.Request [ref.class]
library/unittest.mock.rst:2826: WARNING: py:attr reference target not found: side_effect [ref.attr]
library/unittest.mock.rst:2826: WARNING: py:attr reference target not found: return_value [ref.attr]
      33

After:

❯ make -C Doc html SPHINXOPTS="-n -W --keep-going" SOURCES="library/unittest.mock.rst" 2>&1 | grep WARNING | tee >(wc -l)
library/unittest.mock.rst:740: WARNING: py:attr reference target not found: spec [ref.attr]
library/unittest.mock.rst:763: WARNING: py:attr reference target not found: spec [ref.attr]
library/unittest.mock.rst:763: WARNING: py:attr reference target not found: spec_set [ref.attr]
library/unittest.mock.rst:1287: WARNING: py:attr reference target not found: spec [ref.attr]
library/unittest.mock.rst:2204: WARNING: py:meth reference target not found: MagicMock.__iter__ [ref.meth]
library/unittest.mock.rst:2593: WARNING: py:attr reference target not found: spec [ref.attr]
library/unittest.mock.rst:2618: WARNING: py:attr reference target not found: spec [ref.attr]
       7

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

@hugovk hugovk added docs Documentation in the Doc dir skip news labels Sep 15, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Sep 15, 2024
Open
@hugovk hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Sep 16, 2024
@hugovk hugovk merged commit a5716a3 into python:main Oct 9, 2024
@hugovk hugovk deleted the docs-fix-sphinx-warnings-unittest.mock branch October 9, 2024 14:02
@miss-islington-app

miss-islington-app Bot commented Oct 9, 2024

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 9, 2024
@hugovk @miss-islington
pythongh-101100: Fix Sphinx warnings in library/unittest.mock.rst (p… …
4d33e2a 
…ythonGH-124106)

(cherry picked from commit a5716a3)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 9, 2024
@hugovk @miss-islington
pythongh-101100: Fix Sphinx warnings in library/unittest.mock.rst (p… …
25fe750 
…ythonGH-124106)

(cherry picked from commit a5716a3)

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

bedevere-app Bot commented Oct 9, 2024

Copy link
Copy Markdown

GH-125190 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Oct 9, 2024
@bedevere-app

bedevere-app Bot commented Oct 9, 2024

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Oct 9, 2024
hugovk added a commit that referenced this pull request Oct 9, 2024
@miss-islington @hugovk
[3.13] gh-101100: Fix Sphinx warnings in library/unittest.mock.rst (G… …
ab5f179 
…H-124106) (#125190)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Oct 9, 2024
@miss-islington @hugovk
[3.12] gh-101100: Fix Sphinx warnings in library/unittest.mock.rst (G… …
7187d4f 
…H-124106) (#125191)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@cmaloney cmaloney mentioned this pull request Jun 11, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vstinner vstinner vstinner left review comments

@picnixz picnixz picnixz left review comments

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hugovk @vstinner @picnixz