Support Python 3.5's typing module (and backport)

nicolashainaux / sphinx-autodoc-annotation

Use Python 3 annotations in sphinx-enabled docstrings

BSD 3-Clause "New" or "Revised" License

44 stars 5 forks source link

Support Python 3.5's typing module (and backport) #4

Open evanunderscore opened 8 years ago

evanunderscore commented 8 years ago

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 commented 7 years ago

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?