On May 5, 4:08 am, Simon King <simon.k...@uni-jena.de> wrote:
> Dear Sage-Devel,
>
> I have four questions that I couldn't find addressed on "Producing New
> Sage Packages"
> athttp://modular.math.washington.edu/sage/doc/developer/producing_spkgs...
>
> I can create my spkg with
> sage -pkg my_package_name-3.1415
> so that's not the question.
>
> 1. hg
> When the package is made, it is remarked that there is no mercurial
> repository in the package
> Should there be one? The above page doesn't mention it, if I'm not
> mistaken.
Yes, everything but src should be under revision control.
> 2. SPKG.txt
> When it is made, it complains about SPKG.txt being missing.
> SPKG.txt is not mentioned in the above page, although it would be the
> right place IMO.
> Is there any guide line about writing SPKG.txt?
There are plenty of examples in the wiki (just search for SPKG.txt) or
look into various spkgs. Some are better than other examples.
> 3. Documentation
> With
> sage -docbuild reference html
> one can produce nice manual pages. Is there some support for producing
> html documentation of a package?
> Wouldn't the following be a nice feature:
> sage -docbuild package_name html
> produces an html documentation for the package and inserts it into the
> sage reference manual, perhaps as a section 'package_name' in a
> chapter 'Installed Packages'. Of course it is assumed here that there
> is some appropriate infrastructure in the package.
No, it should not be inserted into the reference manual. There was
talk about having spkg install documentation into $SAGE_LOCAL/doc/foo
for foo.spkg, but no one has implemented anything in that direction.
> 4. Testing
> Is automated (doc) testing of an spkg supported?
Use spkg-check - there are plenty of examples, but there is no
doctesting example per se in Sage yet.
> Best regards,
> Simon
Cheers,
Michael
--~--~---------~--~----~------------~-------~--~----~
To post to this group, send email to sage-devel@googlegroups.com
To unsubscribe from this group, send email to
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---
