#11665: Don't delete built Sage documentation until Sphinx has been successfully
(re)installed
-----------------------------+----------------------------------------------
Reporter: leif | Owner: tbd
Type: defect | Status: needs_review
Priority: major | Milestone: sage-4.7.2
Component: packages | Keywords: spkg doc/output html latex
Work_issues: | Upstream: N/A
Reviewer: John Palmieri | Author: Leif Leonhardy
Merged: | Dependencies: #11659
-----------------------------+----------------------------------------------
Comment(by jhpalmieri):
If #6495 gets reviewed and merged, it will speed up generation of the
reference manual on machines with many processors. So deleting the output
wouldn't be as much of an issue then. (The reference manual is the real
bottleneck; everything else takes just a few minutes.)
The deletion of the output was introduced in #7286. Some options:
- Delete the output, as is done now.
- Don't delete the output, but print a message after installation about
potential problems. Such a message may get lost among many others during
a run of `sage -upgrade`.
- Delete the output if we've updated the version of Sphinx (which we can
tell by looking at the name of the Sphinx directory in
SAGE_LOCAL/lib/python/site-packages), but not otherwise. But Sage-
specific changes in Sphinx, which wouldn't affect the Sphinx version
number, could conceivably lead to incompatible pickles.
The first of these is in some sense the safest, since it is the status
quo. It will make some operations take more time, but it won't cause
things to fail in confusing ways. The others could lead to failures and
confusing error messages. So your comment that deleting the docs has
"more potential of annoyance than not doing so" depends on your point of
view: is it better to make things work but take longer, or to have them be
faster but possibly fail in confusing ways.
Speaking of confusing error messages, for a while now, running "sage
-docbuild tutorial pickle" (or replace 'pickle' by 'json') has failed...
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11665#comment:16>
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.
