#8258: get "make documentation" relocation-safe
-----------------------------+----------------------------------------------
Reporter: GeorgSWeber | Owner: mvngu
Type: defect | Status: new
Priority: minor | Milestone: sage-4.3.3
Component: documentation | Keywords:
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
As of Sage-4.3.2 (and since quite some versions before now), if you newly
install Sage from a binary distribution, and type "make" in the SAGE_ROOT
directory, then the build process will re-create all of the documentation,
although this had been part of the bdist already, and the contents didn't
change and will be the same.
To be crystal clear: this ticket is not about detaching the creation of
the docs from the make/build process (that is the topic of trac ticket
#7943).
This ticket here is about the annoying fact that Sphinx (?) obviously uses
mechanisms to detect whether to rebuild the ReST docs or not, that are
insufficient in important use cases for Sage!
Another use case is simple relocation (hence the name of the ticket). I
just tested it, having completed one (superfluous) make run as described
above, then move this entire Sage install to some other directory, type
make (the focus *is* on the documentation part here) again --- and it's
Groundhog Day again ... (re-building all of this documentation takes on my
2 GHz, 2GB machine more than one and a half hours!)
I guess cloning is "only" just another instance suffering from the same
basic problem, i.e. correctly deciding whether the contents of
documentation files are outdated and have to be rebuilt --- or not.
Probably one can use some functionalities provided by SCons, e.g. like
using MD5 hashes instead of timestamps, or like using a decent database to
store the metadata (instead of pickling), to resolve the issue.
(I do think that we need to rewrite ourselves some of the respective parts
of Sphinx here. I don't think that would be many lines of code, though,
and possibly upstream considers to incorporate these changes.)
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8258>
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.
