#10823: environment variable SAGE_SPKG_INSTALL_DOCS to build and install spkg
docs
----------------------------+-----------------------------------------------
Reporter: jason | Owner: tbd
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.6.2
Component: packages | Keywords:
Author: Jason Grout | Upstream: N/A
Reviewer: David Kirkby | Merged:
Work_issues: |
----------------------------+-----------------------------------------------
Comment(by drkirkby):
I take your point about {{{$SPKG_NAME}}}. Leaving it as {{{SPKG_NAME}}} is
the right thing to do.
The file {{{devel/sage-main/doc/en/website/templates/index.html}}} looks
to be the one that generates http://www.sagemath.org/doc/ We can discuss
that on #10853
I forgot, what is shown as lines 221 to 224 in
{{{doc/en/developer/producing_spkgs.rst}}} are indented one space too
much.
I don't have a strong feeling on the following, and are happy to give it a
positive review either way, but something that should at least be
considered.
Should {{{doc/en/developer/producing_spkgs.rst}}} state the
'''developer''' should check if any required software is actually
installed? Or is it better to let the installation fail if the program is
not installed? I assume there should be a helpful message like "latex not
found" generated by a package that needs it.
It might be helpful to add something like this to the sample spkg-install
file, inside your {{{if [ "x$SAGE_SPKG_INSTALL_DOCS" = xyes ] ; then}}}.
{{{
# Before trying to build the documentation, check if any needed programs
are
# present. In the example below we check for 'latex', but this will depend
on the package.
# Some packages may need no extra tools installed, others may require
some.
# We use 'command -v' for testing this, and not 'which' since 'which' is
not
# portable, whereas 'command -v' is defined by POSIX
# if [ `command -v latex` ] ; then
# echo "Good, latex was found, so building the documentation"
# else
# echo "Sorry, can't build the documentation for SPKG_NAME as latex is
not installed"
# fi
}}}
As I say, I don't have a strong opinion.
Fix the indentation and I'll give this a positive review, or make the
developer do more work in testing for the required software. You choose!
Dave
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10823#comment:23>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
