#10350: Fix some remaining issues with sphinx-1.0.4.p3.spkg
-------------------------------+--------------------------------------------
Reporter: jdemeyer | Owner: tbd
Type: defect | Status: positive_review
Priority: blocker | Milestone: sage-4.6.1
Component: packages | Keywords: sphinx spkg
Author: Jeroen Demeyer | Upstream: N/A
Reviewer: Minh Van Nguyen | Merged:
Work_issues: |
-------------------------------+--------------------------------------------
Changes (by mvngu):
* status: needs_review => positive_review
Old description:
> '''This ticket is a follow-up to #10118 (merged in sage-4.6.1.alpha2)'''
>
> Here are some trivial problems in the file `SPKG.txt` of version ".p3" of
> the Sphinx package:
>
> * In the section
> {{{
> == Dependencies ==
>
> This depends on Jinja >= 2, Pygments >= 0.8, and docutils >= 0.4.
> }}}
> we should have "Pygments >= 1.3.1" due to ticket #10290, and "Jinja2 >=
> 2'''.2'''". But this is no biggy; it's a trivial typo that can either (i)
> be fixed in a new ticket, or (ii) fixed in the current ticket.
>
> * In the section
> {{{
> * patches/pngmath.patch: This replaces \usepackage[utf8x]{inputenc}
> by \usepackage[utf8]{inputenc} in the LaTeX preamble for building
> images in the HTML documentation. This change is done because some
> LaTeX installations have only utf8, not utf8x (utf8x adds support for
> much more Unicode characters, but these are needed used to typeset the
> mathematics in the Sage documentation).
> }}}
> the fragment
> {{{
> but these are needed used to typeset the
> }}}
> should be changed to
> {{{
> but these are used to typeset the
> }}}
>
> Tested on the following platforms:
>
> * {sage.math, bsd.math, hawk}: Both HTML and PDF versions of
> documentation built OK. For the PDF version, building the reference
> manual produced some warnings about "unusable reference target", which
> are to do with relative links to other documents in the Sage standard
> documentation.
>
> * {cleo, iras}.skynet: Sage 4.6.1.alpha2 fails to build on this machine,
> hence the documentation doesn't get built at all.
>
> * {cicero, eno, lena, sextus, taurus, t2}: The HTML version of the
> documentation mostly built OK, but with warnings about a missing LaTeX
> installation. Consequently, the PDF version of the documentation can't be
> built.
>
> * flavius.skynet -- The PDF version of the documentation built fine, but
> with some warnings about unusable relative links. The HTML version built
> with numerous warnings due to missing the dvipng command.
>
> * {gcc11, gcc16}.fsffrance.org: The HTML version of all documents in the
> standard documentation mostly built OK, but with warnings about the
> missing command "dvipng". This machine has a LaTeX installation, but it
> is missing the file titlesec.sty, hence building the PDF version of any
> document in the standard documentation would hang at the error message:
> {{{
> Style option: `fancybox' v1.3 <2000/09/19> (tvz)
> )
>
> ! LaTeX Error: File `titlesec.sty' not found.
>
> Type X to quit or <RETURN> to proceed,
> or enter new name. (Default extension: sty)
> }}}
>
> * rh.math: The HTML version of all documents in the standard
> documentation mostly built OK, but with warnings about the missing
> command "dvipng". This means that LaTeX typesetting does not render at
> all in the HTML version. This machine has a LaTeX installation, but it is
> missing the file utf8x.def, hence building any document in the standard
> documentation would hang at the error message that prompts for utf8x.def.
> Note that we have the patch
> {{{
> #!diff
> diff -r -u src.old/sphinx/ext/pngmath.py src/sphinx/ext/pngmath.py
> --- src/sphinx/ext/pngmath.py 2010-07-24 12:07:36.000000000 +0200
> +++ src/sphinx/ext/pngmath.py 2010-11-18 09:38:05.428635584 +0100
> @@ -34,7 +34,7 @@
>
> DOC_HEAD = r'''
> \documentclass[12pt]{article}
> -\usepackage[utf8x]{inputenc}
> +\usepackage[utf8]{inputenc}
> \usepackage{amsmath}
> \usepackage{amsthm}
> \usepackage{amssymb}
> }}}
> to use only utf8 instead of utf8x. The same change needs to be made to
> the file `doc/common/conf.py`. See my reviewer patch [attachment:trac-
> 10118_use-utf8.patch]. With this patch, we get pass the issue of the
> missing utf8x.def, but we now run into the following error:
> {{{
> Style option: `fancybox' v1.3 <2000/09/19> (tvz)
> )
>
> ! LaTeX Error: File `titlesec.sty' not found.
>
> Type X to quit or <RETURN> to proceed,
> or enter new name. (Default extension: sty)
> }}}
New description:
'''This ticket is a follow-up to #10118 (merged in sage-4.6.1.alpha2)'''
Here are some trivial problems in the file `SPKG.txt` of version ".p3" of
the Sphinx package:
* In the section
{{{
== Dependencies ==
This depends on Jinja >= 2, Pygments >= 0.8, and docutils >= 0.4.
}}}
we should have "Pygments >= 1.3.1" due to ticket #10290, and "Jinja2 >=
2'''.2'''". But this is no biggy; it's a trivial typo that can either (i)
be fixed in a new ticket, or (ii) fixed in the current ticket.
* In the section
{{{
* patches/pngmath.patch: This replaces \usepackage[utf8x]{inputenc}
by \usepackage[utf8]{inputenc} in the LaTeX preamble for building
images in the HTML documentation. This change is done because some
LaTeX installations have only utf8, not utf8x (utf8x adds support for
much more Unicode characters, but these are needed used to typeset the
mathematics in the Sage documentation).
}}}
the fragment
{{{
but these are needed used to typeset the
}}}
should be changed to
{{{
but these are used to typeset the
}}}
Tested on the following platforms:
* {sage.math, bsd.math, hawk}: Both HTML and PDF versions of
documentation built OK. For the PDF version, building the reference manual
produced some warnings about "unusable reference target", which are to do
with relative links to other documents in the Sage standard documentation.
* {cleo, iras}.skynet: Sage 4.6.1.alpha2 fails to build on this machine,
hence the documentation doesn't get built at all.
* {cicero, eno, lena, sextus, taurus, t2}: The HTML version of the
documentation mostly built OK, but with warnings about a missing LaTeX
installation. Consequently, the PDF version of the documentation can't be
built.
* flavius.skynet -- The PDF version of the documentation built fine, but
with some warnings about unusable relative links. The HTML version built
with numerous warnings due to missing the dvipng command.
* {gcc11, gcc16}.fsffrance.org: The HTML version of all documents in the
standard documentation mostly built OK, but with warnings about the
missing command "dvipng". This machine has a LaTeX installation, but it is
missing the file titlesec.sty, hence building the PDF version of any
document in the standard documentation would hang at the error message:
{{{
Style option: `fancybox' v1.3 <2000/09/19> (tvz)
)
! LaTeX Error: File `titlesec.sty' not found.
Type X to quit or <RETURN> to proceed,
or enter new name. (Default extension: sty)
}}}
* rh.math: The HTML version of all documents in the standard
documentation mostly built OK, but with warnings about the missing command
"dvipng". This means that LaTeX typesetting does not render at all in the
HTML version. This machine has a LaTeX installation, but it is missing the
file utf8x.def, hence building any document in the standard documentation
would hang at the error message that prompts for utf8x.def. Note that we
have the patch
{{{
#!diff
diff -r -u src.old/sphinx/ext/pngmath.py src/sphinx/ext/pngmath.py
--- src/sphinx/ext/pngmath.py 2010-07-24 12:07:36.000000000 +0200
+++ src/sphinx/ext/pngmath.py 2010-11-18 09:38:05.428635584 +0100
@@ -34,7 +34,7 @@
DOC_HEAD = r'''
\documentclass[12pt]{article}
-\usepackage[utf8x]{inputenc}
+\usepackage[utf8]{inputenc}
\usepackage{amsmath}
\usepackage{amsthm}
\usepackage{amssymb}
}}}
to use only utf8 instead of utf8x. The same change needs to be made to
the file `doc/common/conf.py`. See my reviewer patch [attachment:trac-
10118_use-utf8.patch]. With this patch, we get pass the issue of the
missing utf8x.def, but we now run into the following error:
{{{
Style option: `fancybox' v1.3 <2000/09/19> (tvz)
)
! LaTeX Error: File `titlesec.sty' not found.
Type X to quit or <RETURN> to proceed,
or enter new name. (Default extension: sty)
}}}
'''Apply:'''
* http://sage.math.washington.edu/home/jdemeyer/spkg/sphinx-1.0.4.p5.spkg
--
Comment:
The updated spkg is good to go. Thanks!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10350#comment:17>
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.
