search

tox-dev / sphinx-autodoc-typehints

Type hints support for the Sphinx autodoc extension
MIT License
539 stars 101 forks source link

sphinx-autodoc-typehints & numpydoc #347

Open jrast opened 1 year ago

jrast commented 1 year ago

In https://github.com/numpy/numpydoc/issues/196 it was discussed how numpydoc could better handle type annotations. As sphinx-autodoc-typehints already provides a way to pull the type annotations from the signature to the docs it would be nice to use the extension in combination in numpydoc. However, a short test showed that this is currently not working:

2023-04-17_18h03_40

Files for Reproduction: DemoProject.zip

Would it be feasible to implement the sphinx-autodoc-typehints + numpydoc combination? Or is the current behavior due to a wrong setting (for the demo the default settings were used)?

gaborbernat commented 1 year ago

A PR to add support would be welcome, however we don't plan to work on it ourselves.

jrast commented 1 year ago

I realy only know numpydoc from using it, so I don't think I would be able to implement something like this. It seems like numpydoc generates a different structure for the output than napoleon. Maybe @rth can take a look at it?