Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
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
base:main
Are you sure you want to change the base?
Conversation
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. |
I can suggest some solutions:
|
Wouldn't it better to convert the pull request back to a draft? GitHub automatically prevents you from merging those. |
Since this can break people's build workflows, now -- before the first alpha -- is the best time to do it. |
Yeah, it also allows us to link to a specific section, rather than the start of the PEP (e.g. |
If intersphinx is a problem, we could maybe use canonical links forhttps://typing.readthedocs.io. |
Looping back around to this:@JelleZijlstra@encukou Thoughts on next steps now that some time has gone by? |
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. |
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Uh oh!
There was an error while loading.Please reload this page.
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/