10 Oct 2016 by dryobates
The most popular use for Python3's annotations are type hints. By default Sphinx can't use that type hints to document modules. Luckily for us Sphinx is easily extensible...
It was quickly obvious that after introduction of type hints there will quickly arose demand for Sphinx to be able extracting type information directly from code. Why to repeat ourselfs :)
I've found two such extensions:
I felt a little happier with latter one as it removes "type noise" from function signature into type section.
Both are easy to install so I encourage you to try it out.
| [1] | sphinx-autodoc-annotation https://github.com/nicolashainaux/sphinx-autodoc-annotation |
| [2] | sphinx-autodoc-typehints https://github.com/agronholm/sphinx-autodoc-typehints |
