#10620: Upgrade Sphinx to version 1.0.6 (or later)
---------------------------+------------------------------------------------
Reporter: davidm | Owner: mvngu
Type: enhancement | Status: needs_work
Priority: minor | Milestone: sage-4.7.2
Component: packages | Keywords: sphinx upgrade spkg autodoc
Work_issues: | Upstream: N/A
Reviewer: | Author: David Monarres
Merged: | Dependencies:
---------------------------+------------------------------------------------
Changes (by jhpalmieri):
* cc: hivert (added)
Old description:
> Just made a spkg and a change to sage_autodoc in order to upgrade sphinx
> to the latest version. Spkg and patch attached.
New description:
Just made a spkg and a change to sage_autodoc in order to upgrade sphinx
to the latest version. Spkg and patch attached.
-------
Straightforward upgrade:
-
[http://sage.math.washington.edu/home/palmieri/SPKG/sphinx-1.0.8.p0.spkg]
Alternative approach, autogenerating sage-autodoc.py from autodoc.py:
-
[http://sage.math.washington.edu/home/palmieri/SPKG/sphinx-1.0.8.p1.spkg]
- apply [attachment:trac_10620-sage.patch] to the Sage library
--
Comment:
Okay, I have a new spkg, actually, two. The first ("p0") is just a
straightforward upgrade of the previous version. However, we should
probably update sage_autodoc.py in light of changes to the Sphinx
extension autodoc.py, on which it is based. I can provide a patch to the
Sage library modifying sage_autodoc.py if necessary.
A different approach: the second spkg ("p1") autogenerates sage_autodoc.py
from autodoc.py, and saves sage_autodoc.py in sphinx/ext instead of in
sage/doc/common. So using this one requires a change to
sage/doc/common/conf.py, which I've provided. This approach seems as
though it will be easier to maintain, or at least it will be easier to
keep sage_autodoc.py in line with autodoc.py.
With both of these approaches, I get some warnings about cross-references,
which are why the other entries are in the patch for the Sage library.
I'm seeing lots of broken cross-references, though: take a look at the
reference manual for categories/examples/finite_weyl_groups.py:
{{{
Only the following basic operations are implemented:
- :meth:`one`
- :meth:`product`
- :meth:`simple_reflection`
- :meth:`Element.has_right_descent`.
{{{
None of these produces a link. I don't know what's going on.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10620#comment:12>
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.
