search

sphinx-contrib / napoleon

Other
149 stars 48 forks source link

Use napoleon to convert Python docstring to a numpy docstring for entire project #7

Closed basnijholt closed 5 years ago

basnijholt commented 5 years ago

I just joined a scientific project where they use default Python style doc-strings, however, they are terrible to read and write.

I would like to convert the entire project's code base to NumPy style doc-strings.

I know that napoleon can parse both styles, however, is it also possible to generate doc-strings with it?

basnijholt commented 5 years ago

I actually found https://github.com/dadadel/pyment/ which does exactly what I was looking for.