[Cython] code documentation tool

Martin Gysel m.gysel at gmail.com
Wed Apr 1 23:24:17 CEST 2009


Lisandro Dalcin schrieb:
> On Tue, Mar 31, 2009 at 6:51 PM, Martin Gysel <m.gysel at gmail.com> wrote:
>   
>> AFAIK sphinx gets the info for autodoc from the docstring but how does
>> this work for you because my docstrings are removed in the module
>> (according the cython doc, that's the normal behavior).
>>     
>
> What are you talking about, Martin? Cython does not removes any
> docstring (with a few exceptions for some special methods). However,
> perhaps you need to asks Cython to auto-generate signatures for you,
> just add the commented line at the very beginning of your modules:
>
> #cython: embedsignature=True
>   
thx for the hint, now everything works as expected

/martin



More information about the Cython-dev mailing list