pyopenms-docs icon indicating copy to clipboard operation
pyopenms-docs copied to clipboard

Published 20 hours ago • verified publisher icon OpenMS

Follow typestub file support for sphinx autodoc

Open jpfeuffer opened this issue 2 years ago • 4 comments

https://github.com/sphinx-doc/sphinx/issues/7630

This issue is here to track the above issue in sphinx to see when we can have support for our new typestub files to fill/complete the API docs.

Would be really helpful since our type stubs are much more complete than our manual docs.

jpfeuffer avatar Apr 29 '22 15:04 jpfeuffer

Hi @jpfeuffer Sorry I closed the issue by mistake. I will take up this issue now.

rahul799 avatar May 04 '22 08:05 rahul799

Ah but I think this is not possible. You can do an hour of Google research to see if I was mistaken but this is more an issue to keep track of other upstream issues, to see when we might be able to use this functionality

jpfeuffer avatar May 04 '22 08:05 jpfeuffer

Should this be closed or researched further?

tapaswenipathak avatar May 30 '22 15:05 tapaswenipathak

I wanted to keep that issue to track the upstream issue in sphinx. I don't think reading docstrings from typestub files is possible with sphinx right now. If you find something it would be REALLY cool.

jpfeuffer avatar May 30 '22 15:05 jpfeuffer