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

[3.13] gh-125018: Add importlib.metadata semantic link targets (GH-125027) #125047

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented Oct 7, 2024

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


Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) [email protected]
Co-authored-by: Adam Turner [email protected]
(cherry picked from commit cda3b5a)


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

…#125027)

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

---------

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
(cherry picked from commit cda3b5a)
@brettcannon brettcannon requested a review from jaraco October 7, 2024 16:32
@AA-Turner AA-Turner merged commit b0d01a1 into python:3.13 Oct 8, 2024
30 checks passed
@jaraco
Copy link
Member

jaraco commented Dec 24, 2024

Thanks @ncoghlan for this work.

This documentation is (currently) shared with importlib_metadata, so we should either back-port these changes to that package or remove this documentation from that package. I'll spend a few minutes seeing if the changes backport in a straightforward way. If not, due to the way code references work, I'll probably opt to remove the docs from the third-party package.

@jaraco
Copy link
Member

jaraco commented Dec 24, 2024

Oh. I just noticed - this change was applied to 3.13 (only). Does that mean this change shouldn't apply to future releases?

Edit: I see now this is a backport of #125027.

@jaraco
Copy link
Member

jaraco commented Dec 24, 2024

Thanks @ncoghlan for this work.

This documentation is (currently) shared with importlib_metadata, so we should either back-port these changes to that package or remove this documentation from that package. I'll spend a few minutes seeing if the changes backport in a straightforward way. If not, due to the way code references work, I'll probably opt to remove the docs from the third-party package.

Nevermind. I'm reminded that in python/importlib_metadata#466, the docs have been separated. So nothing more to be done.

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