Martin Gysel wrote:
> 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?

Sphinx is good in generating documentation. It's not that satisfying for
generating API docs from sources or through module introspection.


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

Nothing I know of. Epydoc can read the embedded signatures, as long as you
stick with Python 2.x syntax and avoid fancy default values. It will fail
hopelessly (reg-exps, that is) for type annotations in whatever form.

I considered fixing it several times, but I guess when I start investing
this time, I'd rather fix up Sphinx' API doc generation instead. It just
looks better.

Stefan


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

Reply via email to