On Mon, Mar 30, 2009 at 7:18 AM, Martin Gysel <[email protected]> wrote:
> Hi
>
> Can anybody recommend a code documentation tool which works good with
> cython.
> I tried doxygen but I'm rather disappointed. I see the cython project
> uses sphinx for the doc. But is sphinx the best tool to generate api
> docs?

It is the best I know for python, at least.

> Is there something which can analyze cython code and do what
> doxygen does with c or java?

Sphinx API doc works by introspection, so it does not matter so much
whether the underlying code is in python or C (cython is "just" a tool
to generate C in that case).

You can see a simple example here I made for audiolab:

http://www.ar.media.kyoto-u.ac.jp/members/david/softwares/audiolab/sphinx/fullapi.html

And the corresponding source file:

http://github.com/cournape/audiolab/blob/4afd4853dbb273305ab8468e860bf2e651883c20/scikits/audiolab/pysndfile/_sndfile.pyx

David
_______________________________________________
Cython-dev mailing list
[email protected]
http://codespeak.net/mailman/listinfo/cython-dev

Reply via email to