sphinx-autodoc-annotation icon indicating copy to clipboard operation
sphinx-autodoc-annotation copied to clipboard

Support Python 3.5's typing module (and backport)

Open evanunderscore opened this issue 9 years ago • 1 comments

typing module: https://docs.python.org/3/library/typing.html backport: https://pypi.python.org/pypi/typing

Will need some extra logic to handle the new generic types properly. For example, Iterable[int] currently displays as typing.Iterable in the signature and as Iterable in the parameter description.

I may look into this if I get time.

evanunderscore avatar Feb 21 '16 07:02 evanunderscore

After some more searching, I've found https://github.com/agronholm/sphinx-autodoc-typehints, which appears to work correctly for my use cases. Given the discussion on #5, perhaps you could consider updating the readme to point people to that project as an alternative?

evanunderscore avatar Apr 30 '17 10:04 evanunderscore