Fix #9194: autodoc: types in typing module are not hyperlinked #9997
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tk0miya
force-pushed
the
9194_Literal_type_not_hyperlinked
branch
from
da3f818
to
46da1c6
Compare
This converts types in typing module to valid references when `autodoc_unqualified_typehints` option enabled.
To support creating hyperlinks to container types naturally, py domain should take fully-qualified typehints for them. But nobody wants to show "typing." module name on the signature. So this suppresses them automatically.
tk0miya
force-pushed
the
9194_Literal_type_not_hyperlinked
branch
2 times, most recently
from
54045f3
to
bec45e0
Compare
… signature To create hyperlinks to container types automatically, this prepends the module names for the types under "typing" module.
tk0miya
force-pushed
the
9194_Literal_type_not_hyperlinked
branch
from
bec45e0
to
bdbad40
Compare
tk0miya
commented
Dec 25, 2021
tk0miya
force-pushed
the
9194_Literal_type_not_hyperlinked
branch
2 times, most recently
from
9a193df
to
35eafcb
Compare
tk0miya
force-pushed
the
9194_Literal_type_not_hyperlinked
branch
from
35eafcb
to
2ea9118
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Purpose
This converts types in typing module to valid references whenautodoc_unqualified_typehintsoption enabled.