Numpydoc support ?

[hadim]

I use Sphinx to generate documentation but I also use numpydoc as docstring format (which seems pretty similar to Google style).

Any chance for you to adapt Google style to numpydoc ?

Links :

• https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#documenting-classes
• https://github.com/numpy/numpydoc

I will be able to try pyment as soon as numpydoc is supported.

Nice project anyway !

[dadadel]

Actually, I called that kind of docstrings "groups docstrings" as I support several kinds in input but not yet in output. I can add the support for that format also as soon as I have some time :)

[hadim]

Ok, great and thank you !

[dadadel]

hadim, can you connect to the IRC channel #pyment on Freenode server?

[hadim]

Not this afternoon. Tonight I will.

[dadadel]

Hi,

I started the support for numpydoc. Can you connect to IRC to speak about it?

[dadadel]

Hey hadim, Numpydoc is now managed (input/output) in the branch 'add_numpydoc'!

[hadim]

Hi @dadadel and thank you for your work ! I am sorry not being more involved but I am very busy lately. I will have a look as soon as I can to add_numpydoc.

Thanks again !

[hadim]

I finally had a look ! And it seems to work perfectly. Two things (not related to numpydoc I think):

• I don't use Raises section (any chance for you to make it configurable ?)
• I prefer to put docstring below the class name and not below def __init__() : any chance here also to make that configurable ?

[hadim]

I use Sublime Text as text editor. I will try to make a plugin to be able to run pyment on the current opened file (However I dont know when I will have time to do it).

[dadadel]

It would be great to see a plugin using pyment :-) :+1:

• Concerning the sections, I can make Raises section optional so if there was no Raise section in input it won't be added on output.
• When you speak about docstring below class instead of __init__, you mean the docstring generated for __init__ with its parameters? How do you manage the case where there's a docstring below the class AND below the __init__?

I will later add a configuration file management to set some options among these.

[dadadel]

I added the management of excluded and optional sections for the class. It is not yet configurable at the level of the application but I set optional the following sections for the 'raise', 'see also', 'ref', 'note', 'other', 'example', 'method', 'attributes' sections so they won't be generated if not found in input. I merged numpydoc management to master.

The question concerning you init/class comment need is still opened.

[dadadel]

I added option "-d" or "--init2class" to pyment in order to move the docstring from __init__ to class if there was no docstring attached to class and there was one for the init.