#10823: environment variable SAGE_SPKG_INSTALL_DOCS to build and install spkg
docs
-----------------------------+----------------------------------------------
Reporter: jason | Owner: tbd
Type: enhancement | Status: closed
Priority: major | Milestone: sage-4.7
Component: packages | Resolution: fixed
Keywords: | Author: Jason Grout
Upstream: N/A | Reviewer: David Kirkby
Merged: sage-4.7.alpha1 | Work_issues:
-----------------------------+----------------------------------------------
Description changed by ddrake:
Old description:
> 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/<SPKG NAME>/
>
> 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: #10826
> * cython: #10827
> * matplotlib: #10828
> * mpmath: #10829
> * pari: #10830
> * gap: #10825
> * python: #10831
New description:
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/<SPKG NAME>/
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: #10826
* cython: #10827
* matplotlib: #10828
* mpmath: #10829
* pari: #10830
* gap: #10825
* python: #10831
* sagetex: #10908
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10823#comment:33>
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.
