Repository navigation
FR: Add Link to Typing RTD in typing Module #96917
Description
Feature or enhancement
Discussions on adding a link to the typing readthedocs (RTD) on the typing module documentation page have been had:
- python/typing: Make Link to ReadTheDocs Typing Docs More Explicit
- python/typing: Why is typeshed information not integrated into the official python docs?
- python/cpython: Proposal: Convert the typing-module PEPs into a series of HOWTOs
- python/typing: Document Structure and Wishlist
The request is to add a link to the top of the typing module docs linking readers to the page. This would serve the following needs:
- The RTD is not particularly discoverable via search engines (the most notable link is in the README of the typeshed repo)
- A desire has been expressed for incorporating PEPs into a series of HOWTOs and some consensus has been achieved that the RTD would be the best place for this
Pitch
Please add a link to the typing readthedocs on the python typing module docs page.
- It has been suggested that a "See Also" box would work nicely
The OP is open to any implementation resulting in an easily findable and noticeable hyperlink for users.
Previous discussion
Repeated from above:
Activity
pythongh-96917: link to typing.readthedocs.io from typing.rst
pythongh-96917: link to typing.readthedocs.io from typing.rst (python…
gh-96917: link to typing.readthedocs.io from typing.rst (#96921)
pythongh-96917: link to typing.readthedocs.io from typing.rst (python…
[3.10] pythongh-96917: link to typing.readthedocs.io from typing.rst (p…
[3.10] pythongh-96917: link to typing.readthedocs.io from typing.rst (p…
gh-96917: link to typing.readthedocs.io from typing.rst (GH-96921)
[3.10] gh-96917: link to typing.readthedocs.io from typing.rst (GH-96921
AlexWaygood commentedon Sep 20, 2022
The link has been added, and the change has been backported to 3.11 and 3.10.
gh-96917: link to typing.readthedocs.io from typing.rst (GH-96921)