Feneric / doxypypy

A more Pythonic version of doxypy, a Doxygen filter for Python.
GNU General Public License v2.0
149 stars 49 forks source link

Support for numpy docstrings #64

Open vocx-fc opened 5 years ago

vocx-fc commented 5 years ago

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.

Feneric commented 5 years ago

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.

vocx-fc commented 5 years ago

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".

MuellerSeb commented 1 year ago

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.