search

executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
737 stars 196 forks source link

Document Napoleon integration #326

Open PhilipMay opened 3 years ago

PhilipMay commented 3 years ago

Hi, in the MyST FAQ I saw something about autodoc integration.

Maybe you could also write about Napoleon integration: https://sphinxcontrib-https://sphinxcontrib-napoleon.readthedocs.io/en/latest/#.readthedocs.io/en/latest/#

I am asking because many ppl. use this kind of python docstrings.

Thanks Philip

welcome[bot] commented 3 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

choldgraf commented 3 years ago

@PhilipMay thanks for the suggestion - out of curiosity....does it work with napoleon? Have you tried? I am curious and don't know haha :-)

PhilipMay commented 3 years ago

@choldgraf I also do not know. That is the main reason why I requested this. :-) Might try it later...

astrojuanlu commented 3 years ago

Just to clarify, napoleon is part of Sphinx these days https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html

astrojuanlu commented 2 years ago

does it work with napoleon? Have you tried?

Sorry I missed this question half a year ago 😃 poliastro uses napoleon (NumPy-style) syntax for docstrings and works beautifully with MyST-Parser. See for example docs vs source.