-
-
Notifications
You must be signed in to change notification settings - Fork 107
autodoc_type_aliases #284
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
Comments
PR welcome 😊 |
@patrick-nicodemus - I just pushed the PR to address this. The latest release (2.2) has it merged. So, please try it out. It should honor the |
Closing as completed by #459. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As of version 3.3, Sphinx provides the functionality for a dictionary called
autodoc_type_aliases
in which the user can explicitly put type aliases that they do not want the autodoc to unravel in the documentation.https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_type_aliases
It would be good if this plugin would also support this feature or provide an equivalent! I was trying to understand why adding values to this dictionary was not having the desired effect as described in the documentation above and spent a while trying to debug this before I realized that this package is either interfering with that functionality or does not replace it.
This is closely related to #132, however at the current time even when using the syntax
MyType : TypeAlias = Tuple[int,str]
of https://www.python.org/dev/peps/pep-0613/ this appears not to solve the problem.The text was updated successfully, but these errors were encountered: