[f2py] adding documentation to automatic f2py job

Pearu Peterson pearu at cens.ioc.ee
Tue Jun 10 12:49:16 EEST 2008


Hi,

f2py currently supports only automatically generated documentation
strings. There is a plan to add ReST and user defined docs support
to f2py and half of the work is also done in this direction. However,
it is unfinished and at the moment I don't have time to work on it.
But feel free to create a ticket to numpy trac and sign it to me.

Pearu

Frédéric Dubois wrote:
> hello,
> I'm trying without success to add some documentation to the auto 
> generated f2py __doc__  !!
> For example i would like to add a few words on the purpose of function, 
> on the
> meaning of an argument.
> It seems that some things are possible (note, --latex-doc, ...) but in 
> fact i didn't succeed in using it.
> May be some one can explain me
> - how the "note()" attribute is working
> - if the --latex-doc option is working  and how to use it
> - etc
> 
> I suppose i'm not the only one concerned with "user documentation" ...
> 
> regards
> 
> 



More information about the f2py-users mailing list