Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-125018: Add importlib.metadata semantic link targets #125027

Merged

Conversation

ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented Oct 6, 2024

This allows direct intersphinx references to APIs via references like :func:`importlib.metadata.version`.


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

This allows direct intersphinx references to APIs via references
like `` :func:`importlib.metadata.version` ``.
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

Thanks @ncoghlan.

Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
ncoghlan and others added 2 commits October 7, 2024 16:35
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Copy link
Contributor Author

@ncoghlan ncoghlan left a comment

Choose a reason for hiding this comment

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

Thanks for the review comments folks. Mostly accepted and included in the latest push, a few more detailed responses inline.

Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
Doc/library/importlib.metadata.rst Outdated Show resolved Hide resolved
@ncoghlan
Copy link
Contributor Author

ncoghlan commented Oct 7, 2024

Thanks for the reviews folks. Merging this to get the link targets added, we can always adjust the docs further in future PRs.

@ncoghlan ncoghlan merged commit cda3b5a into python:main Oct 7, 2024
23 checks passed
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

Sorry, @ncoghlan, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker cda3b5a576412a8671bbe4c68bb792ec14f1a4b1 3.13

@ncoghlan ncoghlan deleted the gh-125018-importlib-metadata-semantic-refs branch October 7, 2024 13:44
@miss-islington-app
Copy link

Sorry, @ncoghlan, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker cda3b5a576412a8671bbe4c68bb792ec14f1a4b1 3.12

ncoghlan added a commit to ncoghlan/cpython that referenced this pull request Oct 7, 2024
…#125027)

This allows direct intersphinx references to APIs via references
like `` :func:`importlib.metadata.version` ``.

---------

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
(cherry picked from commit cda3b5a)
@bedevere-app
Copy link

bedevere-app bot commented Oct 7, 2024

GH-125047 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 7, 2024
@bedevere-app
Copy link

bedevere-app bot commented Oct 7, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Oct 7, 2024
@ncoghlan
Copy link
Contributor Author

ncoghlan commented Oct 7, 2024

3.12 backport is set to automerge, 3.13 backport merge will have to wait until the branch is unlocked post-3.13.0.

ncoghlan added a commit that referenced this pull request Oct 7, 2024
…5027) (#125048)

This allows direct intersphinx references to APIs via references
like `` :func:`importlib.metadata.version` ``.

---------

(cherry picked from commit cda3b5a)

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit that referenced this pull request Oct 8, 2024
…5027) (#125047)

gh-125018: Add importlib.metadata semantic link targets (#125027)

This allows direct intersphinx references to APIs via references
like `` :func:`importlib.metadata.version` ``.

(cherry picked from commit cda3b5a)

---------

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants