search

OpenMS / pyopenms-docs

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.
https://pyopenms.readthedocs.io
Other
42 stars 52 forks source link

Follow typestub file support for sphinx autodoc #268

Open jpfeuffer opened 2 years ago

jpfeuffer commented 2 years ago

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.

rahul799 commented 2 years ago

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

jpfeuffer commented 2 years ago

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

tapaswenipathak commented 2 years ago

Should this be closed or researched further?

jpfeuffer commented 2 years ago

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.