#16396: upgrade Sphinx to 1.2
-------------------------------------+-------------------------------------
Reporter: rws | Owner:
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-6.4
Component: documentation | Resolution:
Keywords: speed, slow, | Merged in:
build, rst | Reviewers:
Authors: | Work issues:
Report Upstream: Reported | Commit:
upstream. No feedback yet. | 761be309a895a85c91ec24af8acc69eca0126faf
Branch: | Stopgaps:
u/rws/upgrade_sphinx_to_1_2 |
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by Snark):
Ok, doing things less stupidly does make things better (who would have
thought?! ;-P ) : it builds and there are three failing doctests, which
are trivial to fix: those doctests expect a newline before a div, and
there are none now:
{{{
sage -t --long local/lib/python2.7/site-
packages/sagenb-0.10.8.2-py2.7.egg/sagenb/misc/sphinxify.py
**********************************************************************
File "local/lib/python2.7/site-
packages/sagenb-0.10.8.2-py2.7.egg/sagenb/misc/sphinxify.py", line 69, in
sagenb.misc.sphinxify.sphinxify
Failed example:
sphinxify('A test')
Expected:
'\n<div class="docstring">\n \n <p>A test</p>\n\n\n</div>'
Got:
'<div class="docstring">\n \n <p>A test</p>\n\n\n</div>'
**********************************************************************
File "local/lib/python2.7/site-
packages/sagenb-0.10.8.2-py2.7.egg/sagenb/misc/sphinxify.py", line 71, in
sagenb.misc.sphinxify.sphinxify
Failed example:
sphinxify('**Testing**\n`monospace`')
Expected:
'\n<div class="docstring"...<strong>Testing</strong>\n<span
class="math"...</p>\n\n\n</div>'
Got:
'<div class="docstring">\n \n <p><strong>Testing</strong>\n<span
class="math">monospace</span></p>\n\n\n</div>'
**********************************************************************
File "local/lib/python2.7/site-
packages/sagenb-0.10.8.2-py2.7.egg/sagenb/misc/sphinxify.py", line 73, in
sagenb.misc.sphinxify.sphinxify
Failed example:
sphinxify('`x=y`')
Expected:
'\n<div class="docstring">\n \n <p><span
class="math">x=y</span></p>\n\n\n</div>'
Got:
'<div class="docstring">\n \n <p><span
class="math">x=y</span></p>\n\n\n</div>'
**********************************************************************
1 item had failures:
3 of 10 in sagenb.misc.sphinxify.sphinxify
[14 tests, 3 failures, 0.44 s]
}}}
I also had a look at the branch to see how the patches looked like : there
is a strange chunk on src/doc/common/multidocs.py with a test on whether
the sphinx version is less or above 1.2... which makes no sense if we're
upgrading to 1.2.2!
So I would say : rebase the branch, fix the tarball issues (name,
checksum), remove the chunk mentioned above, fix the doctests and it will
be good to review and close!
PS: in fact, I may give git-trac a try and push a patch fixing the
doctests this evening... if I manage to.
--
Ticket URL: <http://trac.sagemath.org/ticket/16396#comment:33>
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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
