#11197: Make spkg docs be built and installed after the full build
------------------------+---------------------------------------------------
Reporter: jason | Owner: tbd
Type: defect | Status: needs_info
Priority: major | Milestone: sage-4.7.2
Component: packages | Keywords: sd32
Work_issues: | Upstream: N/A
Reviewer: | Author: John Palmieri
Merged: | Dependencies:
------------------------+---------------------------------------------------
Comment(by jhpalmieri):
Right now, I'm more in favor of adding a target to the Makefile, rather
than the environment variable approach.
Replying to [comment:17 leif]:
> Hmmm, one problem I see is that a couple of spkgs would need a
(re)`configure` before e.g. `make install-docs` etc. would work.
Well, this would be taken care of by the doc install script for the
particular spkg. The whole point of this ticket is to install the docs
separately from the full build, so I'm not sure I understand your
concerns. If you want to build the docs during the build, use the
approach in #10823, and the spkg-install file can take care of the proper
configurations to do things efficiently. (So maybe some spkgs would
behave differently depending on whether you ran `make spkg-doc` compared
to `make` with `SAGE_SPKG_INSTALL_DOCS=yes`: in the first case, a special
script `spkg-install-docs` would be run, while in the first case, the code
would be in `spkg-install`. Or is that too complicated?)
> Also, many packages provide [alternate] documentation in various formats
(man pages, texinfo files, HTML, dvi / PDF etc.), some of which require
tools (i.e., prerequisites either provided by the system or Sage), and
some even some small build process just to prepare the sources for other
tools. So it isn't always clear ''what'' would be installed [in addition].
Re-unpacking and re-configuring an spkg just to install docs is IMHO also
a bit odd, just like keeping the build directories until eventually some
tools are available after the normal build has finished.
There could be several possible targets: `make spkg-doc` which would build
whatever the spkg maintainers thought was a sensible default, but also
`make spkg-doc-html`, `make spkg-doc-man`, etc. Perhaps the script `spkg
/install-spkg-docs ` should pass an argument ("html", "pdf", "default",
etc.) to each individual `spkg-install-docs` script.
> The easiest way would be to simply include some ''pre-built'' versions
of documentation requiring external tools, and just copy / install them if
`SAGE_SPKG_INSTALL_DOCS=yes` or an spkg's `spkg-install-docs` is run. This
could at least in some cases increase an spkg's size significantly though.
I don't think the size increase would be acceptable.
Replying to [comment:18 leif]:
> We could also support some kind of `SAGE_SPKG_INSTALL_DOCS=no` (and
`=later`) in `spkg-install`, but that still doesn't tell ''which kind of''
documentation.
or `SAGE_SPKG_INSTALL_DOCS=html`
> No matter if we build / install any documents for some spkg (or whether
they are available at all in the spkg itself), we could create HTML pages
with links to upstream [documentation] if appropriate.
Sure, that sounds like a good idea. Probably for another ticket, once we
get this framework set up. At least, setting up these html pages would
seem to require another set of ideas and therefore add another level of
complications.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11197#comment:19>
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.
