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-117539: Link to the Python typing spec in typing docs#117540

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

Open
JelleZijlstra wants to merge4 commits intopython:main
base:main
Choose a base branch
Loading
fromJelleZijlstra:intertype

Conversation

JelleZijlstra
Copy link
Member

@JelleZijlstraJelleZijlstra commentedApr 4, 2024
edited by github-actionsbot
Loading

This sets up intersphinx and replaces a few PEP links in typing.rst with intersphinx links to the PEPs.

I'm going to ask in the Python Docs discord whether there are any concerns with enabling intersphinx on the Python docs, and wait for an answer before investing time into replacing the remaining links.


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

@JelleZijlstra
Copy link
MemberAuthor

From Petr's comments on Discord, it appears this may cause issues for redistributors (e.g., Linux distros) because it means that building the docs will require Internet access. I think I'll have to open a discussion on Discuss about it first.

@picnixz
Copy link
Member

I can suggest some solutions:

  1. Provide a copy of the typing inventory. Internet connection is not needed if you have a local copy of the intersphinx inventory.
  2. I'm not sure if you really need the full power of intersphinx since most of the links you are referring to are sections or HTML pages that I doubt would change without you noticing it. For instance, in Sphinx, we have the same issue where we need to refer to the docutils specs but there is no intersphinx support for docutils, so we usesphinx.ext.extlinks instead. However, this is quite fragile against URL changes.
mr-c reacted with thumbs up emoji

@nineteendo
Copy link
Contributor

Wouldn't it better to convert the pull request back to a draft? GitHub automatically prevents you from merging those.

@serhiy-storchakaserhiy-storchaka added the needs backport to 3.13bugs and security fixes labelMay 9, 2024
@encukou
Copy link
Member

Since this can break people's build workflows, now -- before the first alpha -- is the best time to do it.
I wouldn't backport it, though.

nineteendo reacted with thumbs up emoji

@nineteendo
Copy link
Contributor

Yeah, it also allows us to link to a specific section, rather than the start of the PEP (e.g.typing.overload).

@JelleZijlstra
Copy link
MemberAuthor

@encukou that's an option, but it would be a shame if we aren't able to make this change in the 3.12 and 3.13 docs. Ideally, we'd have a lot of cross-links to the spec.

Maybe at PyCon I can spend some time trying to figure out a robust solution based on@picnixz's suggestions.

@nineteendo
Copy link
Contributor

If intersphinx is a problem, we could maybe use canonical links forhttps://typing.readthedocs.io.

@encukouencukou added the docsDocumentation in the Doc dir labelSep 6, 2024
@willingc
Copy link
Contributor

Looping back around to this:@JelleZijlstra@encukou Thoughts on next steps now that some time has gone by?

@JelleZijlstra
Copy link
MemberAuthor

I'd like this to happen but I don't know if I'll have time to push for and implement a robust solution. I'd be happy if someone else did, though.

willingc reacted with thumbs up emoji

@hugovkhugovk removed the needs backport to 3.12only security fixes labelApr 10, 2025
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@serhiy-storchakaserhiy-storchaka added the needs backport to 3.14bugs and security fixes labelMay 8, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@hugovkhugovkhugovk left review comments

@hauntsaninjahauntsaninjahauntsaninja approved these changes

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

@willingcwillingcAwaiting requested review from willingc

@AA-TurnerAA-TurnerAwaiting requested review from AA-TurnerAA-Turner is a code owner

Assignees
No one assigned
Labels
awaiting changesDO-NOT-MERGEdocsDocumentation in the Doc dirneeds backport to 3.13bugs and security fixesneeds backport to 3.14bugs and security fixesskip news
Projects
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

9 participants
@JelleZijlstra@picnixz@nineteendo@encukou@willingc@hugovk@hauntsaninja@AlexWaygood@serhiy-storchaka

[8]ページ先頭

©2009-2025 Movatter.jp