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 intutorial/appendix.rst#108750

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

sobolevn
Copy link
Member

@sobolevnsobolevn commentedSep 1, 2023•
edited
Loading

Warnings before:

/Users/sobolev/Desktop/cpython/Doc/tutorial/appendix.rst:104: WARNING: py:mod reference target not found: sitecustomize/Users/sobolev/Desktop/cpython/Doc/tutorial/appendix.rst:104: WARNING: py:mod reference target not found: usercustomize/Users/sobolev/Desktop/cpython/Doc/tutorial/appendix.rst:116: WARNING: py:mod reference target not found: sitecustomize/Users/sobolev/Desktop/cpython/Doc/tutorial/appendix.rst:116: WARNING: py:mod reference target not found: usercustomize

The problem here is that these module are not documented as.. module::, they are documented as.. index insteadhttps://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-index

..index::pair: module; sitecustomize
After these path manipulations, an attempt is made to import a module named
:mod:`sitecustomize`, which can perform arbitrary site-specific customizations.
It is typically created by a system administrator in the site-packages
directory. If this import fails with an:exc:`ImportError` or its subclass
exception, and the exception's:attr:`name` attribute equals to ``'sitecustomize'``,
it is silently ignored. If Python is started without output streams available, as
with:file:`pythonw.exe` on Windows (which is used by default to start IDLE),
attempted output from:mod:`sitecustomize` is ignored. Any other exception
causes a silent and perhaps mysterious failure of the process.
..index::pair: module; usercustomize
After this, an attempt is made to import a module named:mod:`usercustomize`,

So, I went with:index: inline role. This way once some location is added to their definitions (a header, probably) they will automatically link there.

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

@hugovkhugovkenabled auto-merge (squash)September 1, 2023 10:47
@hugovkhugovk added needs backport to 3.11only security fixes needs backport to 3.12only security fixes labelsSep 1, 2023
@hugovkhugovk merged commit3047f09 intopython:mainSep 1, 2023
@miss-islington
Copy link
Contributor

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

@bedevere-bot

This comment was marked as off-topic.

@miss-islington
Copy link
Contributor

Sorry,@sobolevn and@hugovk, I could not cleanly backport this to3.12 due to a conflict.
Please backport usingcherry_picker on command line.
cherry_picker 3047f09490ae63f25d57efe1d14a9a65d9b5f6db 3.12

@bedevere-bot
Copy link

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

@bedevere-botbedevere-bot removed the needs backport to 3.11only security fixes labelSep 1, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestSep 1, 2023
…onGH-108750)(cherry picked from commit3047f09)Co-authored-by: Nikita Sobolev <mail@sobolevn.me>Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull requestSep 1, 2023
…108750) (#108757)Co-authored-by: Nikita Sobolev <mail@sobolevn.me>Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk pushed a commit to hugovk/cpython that referenced this pull requestSep 1, 2023
pythonGH-108750)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>.(cherry picked from commit3047f09)Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
hugovk pushed a commit to hugovk/cpython that referenced this pull requestSep 1, 2023
pythonGH-108750)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>.(cherry picked from commit3047f09)Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@bedevere-bot
Copy link

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

@bedevere-botbedevere-bot removed the needs backport to 3.12only security fixes labelSep 1, 2023
Yhg1s pushed a commit that referenced this pull requestSep 2, 2023
…108750) (#108759)(cherry picked from commit3047f09)Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@hugovkhugovkAwaiting requested review from hugovkhugovk is a code owner

Assignees

@hugovkhugovk

Labels
awaiting core reviewdocsDocumentation in the Doc dirskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

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