Sphinx not parsing docstring correctly in stub files

haosulab / MPlib

a Lightweight Motion Planning Package

https://motion-planning-lib.readthedocs.io/

MIT License

97 stars 16 forks source link

Sphinx not parsing docstring correctly in stub files #56

Closed Lexseal closed 5 months ago

Lexseal commented 5 months ago

Sphinx is able to automatically document the pyi files. However, it is inconsistent at parsing the doc string correctly, sometimes leaving the arguments in a big clump and removing the return. An example can be found below

Lexseal commented 5 months ago

Will wait for all doc strings to be in sphinx format

Lexseal commented 5 months ago

fixed by kolin's update