On Dec 14, 2007 7:37 PM, William Stein <[EMAIL PROTECTED]> wrote: > > On Dec 14, 2007 5:11 AM, Ondrej Certik <[EMAIL PROTECTED]> wrote: > > > > Hi, > > > > how is the SAGE API reference done? Using docutils? > > No. It doesn't use docutils. > > > I am looking for some tool for documenting SymPy and so far I tried: > > epydoc, pygment, pudge, apydia and all fail for sympy producing some > > error. > > Gees -- just on sympy they fail. Wow. I tried them all on Sage also and > they failed to. So I wrote my own somewhat different doc tool, which
I don't understand how anyone can be using those tools. But I found pydoctor: http://codespeak.net/~mwh/pydoctor/ and it managed to produce quite nice docs of sympy: http://sympy.googlecode.com/svn/api/sympy.html > also deals with Cython code. The entire thing is just the 500-line script: > > SAGE_ROOT/devel/doc/ref/update_script.py > > What it does it generate *latex* directly from a chosen subset of the > Sage source code (the code that is sufficiently stable to be in the > reference manual). Then I run the standard Python documentation > system tools on the result. I.e., I took the documentation that comes > with Python, which is written in latex, and adapted it for Sage, > and in the case of the reference manual -- which I adapted from > the Pythoh Library Reference, made it mostly autogenerated > from source code. > > The file update_script.py above is fairly hackish, but it gets the > job done, actually works, and deals with Cython too (very important). Yes, if we are ever going to use some C, we will use Cython too. I am surprised, that you had to write your own solution... Thanks for the tip. I quite like epydoc 3.0 output - especially that you can see the source code of any function (this really helps for small, undocumented or not so well documented functions), I am missing this in other tools and also in Sage. But epydoc is very fragile and it doesn't work for me, I reported bugs, they fixed some, I reported more and they didn't even answer the bug report. Ondrej --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://sage.scipy.org/sage/ and http://modular.math.washington.edu/sage/ -~----------~----~----~----~------~----~------~--~---
