MyST-NB icon indicating copy to clipboard operation
MyST-NB copied to clipboard
verified publisher icon executablebooks

BUG: API docs looks horrible due to typing info

Open bsipocz opened this issue 6 months ago • 1 comments

The call signatures are really long and unusable IMO. Would be nice to find a good middle ground in generating human readable good API docs.

https://myst-nb.readthedocs.io/en/latest/reference/api.html#parsers

bsipocz avatar Jul 02 '25 20:07 bsipocz

At scipy we tried to look into this, and while Henry fixed the typing issue in #688 we still have a very ugly docs due to a combination of sphinx handling the dataclasses fields and our custom stuff.

It would be wonderful if anyone would be willing and able to fix this :)

bsipocz avatar Jul 13 '25 20:07 bsipocz