-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Open
Labels
extensions:autodocinternals:typingtype:enhancementenhance or introduce a new featureenhance or introduce a new feature
Milestone
Description
Is your feature request related to a problem? Please describe.
sphinx cannot document typing.TypeAliasType
nor typing_extensions.TypeAliasType
.
https://peps.python.org/pep-0695/
Describe the solution you'd like
automodule
should document exported TypeAliasType
s without needing a preceding #:
comment, the same way that classes and functions do not need a preceding #:
.
References to such a type used in the signatures of other functions, types, classes, etc should hyperlink to the type's declaration, the same way that references to a class will hyperlink to the declaration of that class.
The declaration should render similar to how older style type aliases render today, saying "alias of ..."
Describe alternatives you've considered
Additional context
namurphy, electric-coder, mr-cal and mmatous
Metadata
Metadata
Assignees
Labels
extensions:autodocinternals:typingtype:enhancementenhance or introduce a new featureenhance or introduce a new feature