[sage-devel] Re: Epydoc API Documentation for Sage
On Thu, Jul 17, 2008 at 2:44 PM, Mike Hansen <[EMAIL PROTECTED]> wrote: > 4) Ran the following command "epydoc --html -o sage-epydoc sage" Sorry about the double post, but you'll want to add a --docformat=plaintext option in there as well. --Mike --~--~-~--~~~---~--~~ 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://www.sagemath.org -~--~~~~--~~--~--~---
[sage-devel] Re: Epydoc API Documentation for Sage
On Thu, Jul 17, 2008 at 11:53 AM, John Cremona <[EMAIL PROTECTED]> wrote: > > The weirdness seems to appear when the default for a parameter is None. Yeah, I'm not exactly sure why it's doing that. > > What extra magic would cause the latex parts of the docstrings to be > jsmath'ed ? > There are two options. First, you could write a markup module for epydoc ( http://epydoc.sourceforge.net/api/epydoc.markup-module.html ) that processes the docstring and produces the appropriate output. The second option would be to covert Sage's docstrings to a reST format which would be a fair amount of work, but would have lots of advantages. I'll write more about this later. On Thu, Jul 17, 2008 at 1:31 PM, William Stein <[EMAIL PROTECTED]> wrote: > Mike: > > AWESOME!!! I used to use epydoc for sage long ago, but stopped > because it kept crashing more and more when the sage library > got larger. > > Mike: Can you explain precisely how to generate this? Sure. These were the following steps that I took: 1) Download the latest epydoc from http://epydoc.sourceforge.net/ 2) Run sage -sh and run "python setup.py install" 3) Edited $SAGE_ROOT/local/bin/epydoc by adding "import sage.all" right before the "cli()" line. 4) Ran the following command "epydoc --html -o sage-epydoc sage" It runs surprisingly quickly, but used about 450mb of memory . Also, I didn't turn on any of the options to make the graphs, etc. --Mike --~--~-~--~~~---~--~~ 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://www.sagemath.org -~--~~~~--~~--~--~---
[sage-devel] Re: Epydoc API Documentation for Sage
On Thu, Jul 17, 2008 at 12:06 PM, Mike Hansen <[EMAIL PROTECTED]> wrote: > > Hello all, > > I played around a bit with Epydoc this morning and was able to get it > to produce semi-decent output for Sage (by explicitly importing > sage.all at the top of the epydoc script). You can find the > documentation at > http://sage.math.washington.edu/home/mhansen/sage-epydoc . > > --Mike Mike: AWESOME!!! I used to use epydoc for sage long ago, but stopped because it kept crashing more and more when the sage library got larger. Mike: Can you explain precisely how to generate this? Harald: Could you add documentation like this to the sagemath.org website? It's not perfect but I think we should make it nicely available soon. In the meantime, we could just link to http://sage.math.washington.edu/home/mhansen/sage-epydoc Also, http://sagemath.org/doc/html/ needs to be updated. I don't know how to do that anymore now that you have the new website setup. That directory should equal the contents of /home2/sage/build/sage-3.0.5/devel/doc/html Harald -- could you either update this or just tell me what to change and how? Obviously, I could just start poking at files in home2/sage/www-files, but it would be better to have some direction. Thanks! William --~--~-~--~~~---~--~~ 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://www.sagemath.org -~--~~~~--~~--~--~---
[sage-devel] Re: Epydoc API Documentation for Sage
The weirdness seems to appear when the default for a parameter is None. What extra magic would cause the latex parts of the docstrings to be jsmath'ed ? John 2008/7/17 David Harvey <[EMAIL PROTECTED]>: > > > On Jul 17, 2008, at 6:06 AM, Mike Hansen wrote: > >> >> Hello all, >> >> I played around a bit with Epydoc this morning and was able to get it >> to produce semi-decent output for Sage (by explicitly importing >> sage.all at the top of the epydoc script). You can find the >> documentation at >> http://sage.math.washington.edu/home/mhansen/sage-epydoc . > > Hmmm looks really nice, but there's some strangeness, e.g. the > documentation for next_prime() in sage.rings.arith has some weird > stuff in the "proof" flag. > > david > > > > > --~--~-~--~~~---~--~~ 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://www.sagemath.org -~--~~~~--~~--~--~---
[sage-devel] Re: Epydoc API Documentation for Sage
On Jul 17, 2008, at 6:06 AM, Mike Hansen wrote: > > Hello all, > > I played around a bit with Epydoc this morning and was able to get it > to produce semi-decent output for Sage (by explicitly importing > sage.all at the top of the epydoc script). You can find the > documentation at > http://sage.math.washington.edu/home/mhansen/sage-epydoc . Hmmm looks really nice, but there's some strangeness, e.g. the documentation for next_prime() in sage.rings.arith has some weird stuff in the "proof" flag. david --~--~-~--~~~---~--~~ 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://www.sagemath.org -~--~~~~--~~--~--~---
[sage-devel] Re: Epydoc API Documentation for Sage
Wow. This is amazing and great that you did this! Thanks very much Mike. On Thu, Jul 17, 2008 at 6:06 AM, Mike Hansen <[EMAIL PROTECTED]> wrote: > > Hello all, > > I played around a bit with Epydoc this morning and was able to get it > to produce semi-decent output for Sage (by explicitly importing > sage.all at the top of the epydoc script). You can find the > documentation at > http://sage.math.washington.edu/home/mhansen/sage-epydoc . > > --Mike > > (Note that this was generated from a Sage tree that had a few of the > sage-combinat patches already applied. Needless to say, the > documentation for sage.combinat isn't quite what's in 3.0.5) > > > > --~--~-~--~~~---~--~~ 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://www.sagemath.org -~--~~~~--~~--~--~---
[sage-devel] Re: Epydoc API Documentation for Sage
I took a quick look at that link and it looks brilliant to me. Just this afternoon Francis Clarke and I were saying how nice it would be to have something just like this, and I observed that there was probably someone in the Sage community clever enough to do it. Were you reading my mind? John 2008/7/17 Mike Hansen <[EMAIL PROTECTED]>: > > Hello all, > > I played around a bit with Epydoc this morning and was able to get it > to produce semi-decent output for Sage (by explicitly importing > sage.all at the top of the epydoc script). You can find the > documentation at > http://sage.math.washington.edu/home/mhansen/sage-epydoc . > > --Mike > > (Note that this was generated from a Sage tree that had a few of the > sage-combinat patches already applied. Needless to say, the > documentation for sage.combinat isn't quite what's in 3.0.5) > > > > --~--~-~--~~~---~--~~ 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://www.sagemath.org -~--~~~~--~~--~--~---
