doxypypy
doxypypy copied to clipboard
Support for numpy docstrings
It seems that doxypypy
can parse the Google docstring style well. What about numpy
style? I think this style should also be recognized as it's one of the most common styles, used by many in the scientific community.
I've never personally tried. I've been told at least one other person has had limited success with it.
Patches (with tests) would certainly be welcome! There is nothing preventing doxypypy from incorporating the functionality and there is no anti-NumPy sentiment at play here. It's just that there has not yet been enough interest from devs to make it happen.
Thank you for the reply.
I hope I don't sound too demanding. Since you know the code well maybe it's easier for you to add this support with the examples that I provide above. I could try to do it, but that would take me a long time because I would need to understand how doxypypy
works. I'm not familiar with "Python's own abstract syntax tree walker".
I guess the simplest way to do so is to involve pyment in the py_filter
script.
You create a temporary file, where the numpy docstrings style is converted to google docstring style and the apply doxypypy to the temporary file.