#6187: [with patch, needs review] After making a clone, the reference manual
(and
other docs) should not have to be completely rebuilt.
---------------------------+------------------------------------------------
Reporter: jhpalmieri | Owner: tba
Type: enhancement | Status: new
Priority: major | Milestone: sage-4.1.1
Component: documentation | Keywords:
Reviewer: John Cremona | Author: John Palmieri, Mitesh Patel
Merged: |
---------------------------+------------------------------------------------
Comment(by jhpalmieri):
Overall, this works as advertised. I like the new options, the new option
parsing, and the help messages. We might consider eventually updating
mtimes on all of the docs, not just the reference manual, but everything
else is quick enoug to build that it's not a big deal. (To test: I
installed the two patches here and made sure the docs were built. Then I
cloned the current repository and rebuilt the docs. The reference manual
built almost instantly, because it was using the version from the clone.)
Someone else should take a good look at it, though, since I am an author
of part of this (the scripts part). Also, there are a number of changes
to builder.py, and other people should look carefully at them, more
carefully than I have so far.
Other comments: if I do something like {{{sage -docbuild hello html}}},
then it says
{{{
sphinx-build -b html -d
/Applications/sage/devel/sage/doc/output/doctrees/en/hello
/Applications/sage/devel/sage/doc/en/hello
/Applications/sage/devel/sage/doc/output/html/en/hello
Error: Source directory doesn't contain conf.py file.
Build finished. The built documents can be found in
/Applications/sage/devel/sage/doc/output/html/en/hello
}}}
The problem is, it creates a directory SAGE_ROOT/devel/sage/doc/en/hello,
and now "hello" appears in the list of documents. Should there be better
error checking to prevent this from happening?
Actually, I think this belongs on another ticket: it's a "pre-existing
condition", and can be dealt with separately. See #6605.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6187#comment:22>
Sage <http://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
-~----------~----~----~----~------~----~------~--~---
