On Mon, 20 Feb 2012 16:43:29 Benjamin Jones wrote:
> On Mon, Feb 20, 2012 at 2:39 PM, François Bissey
> <francois.bis...@canterbury.ac.nz> wrote:
> <snip>
>
> > There are efforts to parallelize the building of the doc and I would say
> > that if it gets merged we may very well put the doc back into sage and
> > just build it. We could keep fetching pre-built doc for thos who want
> > on slow systems.
> >
> > Francois
>
> Is there currently any way to prevent Sage from building the docs when
> one downloads a new tarball, i.e. something like setting
> SAGE_ATLAS_LIB="..." to avoid building atlas every time a new beta is
> released?
>
> If not, would people support adding an environment variable to this
> effect? Maybe that variable could be set to the location of online
> docs for the last major release, or that variable would cause a script
> to run that downloads pre-built docs (as happens with the
> gentoo-prefix?)
>
I don't think there are efforts for that currently. The building of the doc
happens at the level of the top makefile to build the whole of sage:
# Main Makefile for Sage.
# The default target ("all") builds Sage and the whole (HTML) documentation.
#
# Target "build" just builds Sage.
#
# See below for targets to build the documentation in other formats,
# to run various types of test suites, and to remove parts of the build etc.
PIPE = spkg/pipestatus
all: start doc # indirectly depends on build
build:
cd spkg && \
"../$(PIPE)" \
"env SAGE_PARALLEL_SPKG_BUILD='$(SAGE_PARALLEL_SPKG_BUILD)'
./install all 2>&1" \
"tee -a ../install.log"
./sage -b
build-serial: SAGE_PARALLEL_SPKG_BUILD = no
build-serial: build
# Start Sage if the file local/lib/sage-started.txt does not exist
# (i.e. when we just installed Sage for the first time)
start: build
[ -f local/lib/sage-started.txt ] || local/bin/sage-starts
# You can choose to have the built HTML version of the documentation link to
# the PDF version. To do so, you need to build both the HTML and PDF versions.
# To have the HTML version link to the PDF version, do
#
# $ ./sage --docbuild all html
# $ ./sage --docbuild all pdf
#
# For more information on the docbuild utility, do
#
# $ ./sage --docbuild -H
doc: doc-html
doc-html: build
$(PIPE) "./sage --docbuild --no-pdf-links all html
$(SAGE_DOCBUILD_OPTS) 2>&1" "tee -a dochtml.log"
<....>
If you do make or make all the doc will get built. That's where the
hacking on whether building or downloading should occur. Note that
to run the test the makefile wants you to build the html doc. This is
not necessary (but very useful for the notebook at least in its current
incarnation).
Francois
--
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to
sage-devel+unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org
