#10823: environment variable SAGE_SPKG_INSTALL_DOCS to build and install spkg
docs
----------------------------+-----------------------------------------------
Reporter: jason | Owner: tbd
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-4.6.2
Component: packages | Keywords:
Author: Jason Grout | Upstream: N/A
Reviewer: David Kirkby | Merged:
Work_issues: |
----------------------------+-----------------------------------------------
Comment(by jason):
Replying to [comment:20 jason]:
> Replying to [comment:17 drkirkby]:
> > * There should be a link added to this page
http://www.sagemath.org/doc/ (which is generated from the docs in Sage) to
show the place where the new documentation can be found.
> >
> > Clearly adding the code to the packages is quite simple, but unless it
is well documented it's not going to be much use. People must be able to
find the documentation, which I think will be most easily done if on the
main page http://www.sagemath.org/doc/
This is now #10853
> > * There's a possibility that building some of the documentation may
require external programs like GNU info, LaTeX. makeinfo etc. This needs
to be mentioned in the docs.
>
> Fix coming up.
Done.
>
>
> > * The patch says the documentation gets installed in the file
{{{$SAGE_ROOT/local/share/doc/SPKG_NAME/}}}. I think there should be in
front of $SPKG_NAME - just as with SAGE_ROOT. Also, a more accurate
description is that the docs are installed in one or more directories
below {{{$SAGE_ROOT/local/share/doc/SPKG_NAME/}}}
>
> I didn't put the $ since $SPKG_NAME is not a variable that works in the
spkg-install file. My hope was to help them realize that they needed to
manually fill in SPKG_NAME. I'll put a note to that effect.
PACKAGE_NAME is used quite a bit in other places in that file, so I used
that. That is understood in that file to be a placeholder to be replaced
for a specific package.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10823#comment:21>
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.
