On Mon, Mar 30, 2009 at 4:55 AM, Stefan Behnel <[email protected]> wrote: > > Martin Gysel wrote: >> Can anybody recommend a code documentation tool which works good with >> cython. > > Sphinx is good in generating documentation. It's not that satisfying for > generating API docs from sources or through module introspection. >
Indeed. >> 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. > However, take a look at the script in the below (works as a cmd line replacement for epydoc) Of course you have to remove stuff at the very beginning and at the end (the 'epydoc.cfg' rc file stuff) ... Moreover, this script also monkeypatch the issue of Epydoc trying to generate GIF files in favor of PNG, as Linux distros (Fedora, in my case) disable that format for the famous patents problems http://code.google.com/p/mpi4py/source/browse/trunk/conf/epydocify.py Wait a minute... I've pushed something to Cython a long time ago (Tools/cython-epydoc.py)... But it is likely outdated... -- Lisandro Dalcín --------------- Centro Internacional de Métodos Computacionales en Ingeniería (CIMEC) Instituto de Desarrollo Tecnológico para la Industria Química (INTEC) Consejo Nacional de Investigaciones Científicas y Técnicas (CONICET) PTLC - Güemes 3450, (3000) Santa Fe, Argentina Tel/Fax: +54-(0)342-451.1594 _______________________________________________ Cython-dev mailing list [email protected] http://codespeak.net/mailman/listinfo/cython-dev
