-
Notifications
You must be signed in to change notification settings - Fork 14
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
Type annotations are not rendered properly #62
Comments
Hey @greyli ! Thanks for your input! Indeed, that does not make sense. I wonder, whether this is a problem of autodocsumm or autosummary. What do you get when you include
? |
It's the same as the old output: Source: https://github.com/marshmallow-code/marshmallow/blob/dev/docs/marshmallow.validate.rst I think this may be related to sphinx-doc/sphinx#6311, but that issue seems fixed by sphinx-doc/sphinx#6353. Do you think I should report it to Sphinx? I'm a bit confused with autosummary and autodocsumm, sorry. |
hey @greyli! yes, this is definitely an issue for the sphinx-doc repository and you should make sure that you use the latest version of sphinx. I am closing this then. |
I see, thanks! |
Hi, thanks for the cool project. It seems that the type annotations for the class arguments are not rendered properly. Catch this in Marshmallow docs: https://marshmallow.readthedocs.io/en/stable/marshmallow.validate.html
Take the first
And
class as an example. Here is the raw definition:Expected output:
Actual output:
The text was updated successfully, but these errors were encountered: