#6187: [with patch, needs review] Fix post-cloning docbuild problems and add new
command-line options
---------------------------+------------------------------------------------
Reporter: jhpalmieri | Owner: tba
Type: enhancement | Status: new
Priority: major | Milestone: sage-4.1.2
Component: documentation | Keywords:
Reviewer: John Cremona | Author: John Palmieri, Mitesh Patel
Merged: |
---------------------------+------------------------------------------------
Description changed by mpatel:
Old description:
> From [http://groups.google.com/group/sage-
> devel/browse_frm/thread/87a143a395bd1297 sage-devel]:
> {{{
> > What does force a complete rebuild is making a new branch with "sage -
> > clone". This is annoying; I don't know enough about the build
> > machinery to know if this can be changed.
>
> I agree. If I have built the docs in the main branch and make a
> clone, it would be great of the docs were clones too, as then we would
> only need to build the docs once per release.
> I imagine this is easily doable by adapting the clone script. If
> people agree, could someone make a ticket?
> }}}
> Note that the documentation output is copied (because of #5469), but
> something is still triggering a rebuild. I don't know enough about
> Sphinx to know what is causing this.
New description:
Currently, `sage -clone` requires a rebuild of the Sage documentation.
This ticket attempts to fix this and a few related problems with the
"docbuild" system. It also includes some features added in the course of
fixing the problems:
* Lots of new command-line options. For a list and examples, try, e.g.,
`sage -docbuild -H`. The old options and syntax should still work.
* Progress updates with Python's powerful logging framework, which we may
wish to adopt later for the Sage library.
The only patches to apply are
* [attachment:ticket:6187:trac_6187-new_scripts_v5.patch] to the scripts
repository
* [attachment:ticket:6187:trac_6187-builder_v5.patch] to the sage
repository
All but one of the other patches are earlier versions of these. Please do
not review the remaining, completely optional patch:
* [attachment:ticket:6187:trac_6187_testreference.patch] (apply to the
sage repository)
This adds a test document similar to the reference manual. It covers only
algebras, so it builds much more quickly and may facilitate
experimentation with Sphinx, say. To build it, try `sage -docbuild
testreference html -jv3`.
Please visit the "diff" links below to view earlier ticket descriptions.
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6187#comment:28>
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
-~----------~----~----~----~------~----~------~--~---
