Skip to content
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

sphinx-autodoc-typehints & numpydoc #347

Open
jrast opened this issue Apr 17, 2023 · 2 comments
Open

sphinx-autodoc-typehints & numpydoc #347

jrast opened this issue Apr 17, 2023 · 2 comments

Comments

@jrast
Copy link

jrast commented Apr 17, 2023

In numpy/numpydoc#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
Copy link
Member

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

@jrast
Copy link
Author

jrast commented Apr 17, 2023

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants