- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
autodoc typehints do not create link for parametrized types #9194
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
Labels
Milestone
Comments
Duplicated with #9195? Closing. |
Oh, sorry. I understood these are different topic. Reopened now. |
The issue seems to be stemming from sphinx/sphinx/ext/autodoc/typehints.py Line 33 in 80fbbb8
|
I guess the fix here is to pass these through |
No, it will generate incorrect mark-ups:
|
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 19, 2021
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 19, 2021
…inked This converts Literal types to valid references when `autodoc_unqualified_typehints` option enabled.
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 20, 2021
This converts types in typing module to valid references when `autodoc_unqualified_typehints` option enabled.
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 20, 2021
This converts types in typing module to valid references when `autodoc_unqualified_typehints` option enabled.
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 24, 2021
… signature To create hyperlinks to container types automatically, this prepends the module names for the types under "typing" module.
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 24, 2021
… signature To create hyperlinks to container types automatically, this prepends the module names for the types under "typing" module.
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 24, 2021
… signature To create hyperlinks to container types automatically, this prepends the module names for the types under "typing" module.
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 25, 2021
… signature To create hyperlinks to container types automatically, this prepends the module names for the types under "typing" module.
tk0miya
added a commit
that referenced
this issue
Dec 26, 2021
Fix #9194: autodoc: types in typing module are not hyperlinked
AA-Turner
pushed a commit
to AA-Turner/sphinx
that referenced
this issue
Dec 29, 2021
This converts types in typing module to valid references when `autodoc_unqualified_typehints` option enabled.
AA-Turner
pushed a commit
to AA-Turner/sphinx
that referenced
this issue
Dec 29, 2021
… signature To create hyperlinks to container types automatically, this prepends the module names for the types under "typing" module.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Describe the bug
autodoc typehints normally generate a link to the hinted type, but do not do so for parametrized types.
To Reproduce
Steps to reproduce the behavior:
and open _build/html/project.html
Expected behavior
Literal
(in the parameter description) should link to typing.Literal in CPython's docs, just likeint
does.Your project
N/A
Screenshots

Environment info
Additional context
N/A
The text was updated successfully, but these errors were encountered: