id summary reporter owner description type status priority milestone component resolution keywords cc merged author reviewer upstream work_issues branch commit dependencies stopgaps
10823 environment variable SAGE_SPKG_INSTALL_DOCS to build and install spkg docs jason tbd "There are lots of times when it would be convenient to have the documentation of various spkgs installed in a local or system Sage installation. For example, it seems that I'm always wishing that I had that at an airport or on an airplane. At one point a long time ago, we had an extradocs spkg, but it was never maintained. So here is a proposal:
When building an spkg, if the SAGE_SPKG_INSTALL_DOCS environment variable is yes, then the docs are built (if available in the spkg) and are installed in $SAGE_ROOT/local/share/doc//
For example, numpy includes the docs with the sources. I'd like to insert the following at the bottom of the numpy spkg-install:
{{{
if [ ""x$SAGE_SPKG_INSTALL_DOCS"" = xyes ] ; then
cd doc
make html
if [ $? -ne 0 ]; then
echo ""Error building numpy docs.""
exit 1
fi
mkdir -p $SAGE_ROOT/local/share/doc/numpy
mv build/html $SAGE_ROOT/local/share/doc/numpy
fi
}}}
This builds the numpy docs and makes a directory $SAGE_ROOT/local/share/doc/numpy/html/ that contains the standalone html documentation for numpy.
Here are a few updated spkgs:
* numpy: http://sage.math.washington.edu/home/jason/numpy-1.5.1.p0.spkg (depends on #10792)
* cython: http://sage.math.washington.edu/home/jason/cython-0.14.1.p0.spkg (depends on #10493)
* matplotlib: http://sage.math.washington.edu/home/jason/matplotlib-1.0.1.p0.spkg (depends on #10588)
* mpmath: http://sage.math.washington.edu/home/jason/mpmath-0.15.p0.spkg" enhancement needs_review major sage-4.7 packages: standard drkirkby N/A