#13143: Use MathJax by default when building docs from Makefile
----------------------------------------+-----------------------------------
Reporter: jhpalmieri | Owner: GeorgSWeber
Type: enhancement | Status: needs_review
Priority: minor | Milestone: sage-5.2
Component: build | Resolution:
Keywords: Makefile doc MathJax | Work issues:
Report Upstream: N/A | Reviewers:
Authors: John Palmieri | Merged in:
Dependencies: #9774 | Stopgaps:
----------------------------------------+-----------------------------------
Changes (by jhpalmieri):
* cc: nthiery (added)
Old description:
> At the moment, running `make` runs `make doc`, which in turn runs `make
> doc-html`. This runs Sphinx without the `-j` option, so !MathJax (or
> jsMath, pre #9774) is not used: png image files are used instead. Using
> png images is much slower, so we should use !MathJax (or jsMath) by
> default.
>
> Timing and disk space information:
>
> Tutorial without !MathJax:
> {{{
> $ rm -rf devel/sage/doc/output
> $ time sage --docbuild tutorial html
> ...
> real 2m17.950s
> user 1m29.441s
> sys 0m15.478s
> $ du -s -h devel/sage/doc/output
> 3.9M output/
> }}}
> With !MathJax:
> {{{
> $ rm -rf devel/sage/doc/output
> $ time sage --docbuild tutorial html -j
> ...
> real 0m9.871s
> user 0m6.530s
> sys 0m1.739s
> $ du -s -h devel/sage/doc/output
> 8.5M output/
> }}}
> When building all of the documentation, the disk space actually drops,
> going from about 320M (without !MathJax) to about 295M (with).
New description:
At the moment, running `make` runs `make doc`, which in turn runs `make
doc-html`. This runs Sphinx without the `-j` option, so !MathJax (or
jsMath, pre #9774) is not used: png image files are used instead. Using
png images is much slower, so we should use !MathJax (or jsMath) by
default.
Timing and disk space information:
Tutorial without !MathJax:
{{{
$ rm -rf devel/sage/doc/output
$ time sage --docbuild tutorial html
...
real 2m17.950s
user 1m29.441s
sys 0m15.478s
$ du -s -h devel/sage/doc/output
3.9M output/
}}}
With !MathJax:
{{{
$ rm -rf devel/sage/doc/output
$ time sage --docbuild tutorial html -j
...
real 0m9.871s
user 0m6.530s
sys 0m1.739s
$ du -s -h devel/sage/doc/output
8.5M output/
}}}
When building all of the documentation, the disk space actually drops,
going from about 320M (without !MathJax) to about 295M (with).
----------------
- Apply [attachment:trac_13143-root.v2.patch] to the root repo.
- Apply [attachment:trac_13143-sage.v2.patch] to the Sage library.
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13143#comment:5>
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.
