Stop repeating input/output type info in docstrings

Open leofang opened this issue 11 months ago • 1 comments

I think Sphinx is able to figure out the types and keep them in the document by inspecting the typing info, which going forward should be our source of truth (https://github.com/NVIDIA/cuda-python/issues/312#issue-2746694448). We should not repeat ourselves.

Feb 18 '25 20:02 leofang

I noticed there are some issues for Sphinx to handle type alias properly. We need to proceed with caution.

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

Feb 24 '25 13:02 leofang

Found another relevant issue: https://github.com/sphinx-doc/sphinx/issues/7077, and someone pointed to the sphinx-autodoc-typehint plugin: https://github.com/sphinx-doc/sphinx/issues/7077#issuecomment-1571885203

Jun 11 '25 02:06 leofang