missing sphinxification
YannLC
I think /sage/group/generic.py docstrings have not been changed.
Cheers
davidloeffler
manual. I did a grep:
david@groke:~/sage-3.4.rc0/devel/sage-main/sage> grep "EXAMPL.*[^:]:$"
-lr *
to pick up files that contained "EXAMPLES:" with a single colon rather
than a double one, and it turned up no fewer than 510 files! Some of
these, e.g. algebras/steenrod_algebra.py, are fine -- they just have
examples subdivided into smaller groups within a docstring -- but of
the 10 or so files I looked at, the other 9 were all rogue. In
particular, large parts of the number fields code have no entries in
the reference manual, and nor do group algebras, Kodaira symbols,
Galois groups...
Checking in 3.3, it seems that these files were never linked into the
reference manual in the first place; but is there ever any good reason
why a file that has docstrings should be excluded from the manual?
David
Mike Hansen
On Fri, Mar 6, 2009 at 3:18 AM, davidloeffler <dave.l...@gmail.com> wrote:
>
> There seem to be *hundreds* of files missing from the new reference
> manual. I did a grep:
>
> david@groke:~/sage-3.4.rc0/devel/sage-main/sage> grep "EXAMPL.*[^:]:$"
> -lr *
Yes, there are lots of things not in the reference manual. In 3.4,
you can run "sage -docbuild reference print_unincluded_modules" to get
a list of the ones that aren't in the reference manual.
>
> Checking in 3.3, it seems that these files were never linked into the
> reference manual in the first place; but is there ever any good reason
> why a file that has docstrings should be excluded from the manual?
No, there's not a good reason. The primary reason that they were left
out before was probably people weren't familiar enough with how to
include the autogenerated stuff in the reference manual. Hopefully it
will be easier to work on now.
That being said, we should make an effort to get more included. I
didn't convert any module that wasn't already in the reference manual
since managing / rebasing patches against 400 files over 2 months of
Sage releases was enough work as it is. I can make some improvements
to my code which handles a large chunk of the conversion
automatically, but it's also fairly easy to go through and convert
things by hand.
--Mike
Nicolas M. Thiery
<SNIP>
> didn't convert any module that wasn't already in the reference manual
> since managing / rebasing patches against 400 files over 2 months of
> Sage releases was enough work as it is. I can make some improvements
> to my code which handles a large chunk of the conversion
> automatically, but it's also fairly easy to go through and convert
> things by hand.
Btw: where can I find your script?
Cheers,
Nicolas
--
Nicolas M. Thiéry "Isil" <nth...@users.sf.net>
http://Nicolas.Thiery.name/