#10620: Upgrade Sphinx to version 1.1.2
---------------------------+------------------------------------------------
Reporter: davidm | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: minor | Milestone: sage-4.8
Component: packages | Keywords: sphinx upgrade spkg autodoc
Work_issues: | Upstream: N/A
Reviewer: | Author: John Palmieri
Merged: | Dependencies:
---------------------------+------------------------------------------------
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.
>
> -------
>
> Straightforward upgrade:
>
> -
> [http://sage.math.washington.edu/home/jdemeyer/spkg/sphinx-1.1.2.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
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.
-------
New spkg:
-
[http://sage.math.washington.edu/home/palmieri/SPKG/sphinx-1.1.2.p0.spkg]
--
Comment(by jhpalmieri):
`sage_autodoc` is the Sage version of the Sphinx extension `autodoc`
(found in `sphinx/ext/`); it is used to extract the reference manual from
the source code. We've modified the original to handle various things
(perhaps cython code, lazy methods, cached methods?). So
`sage_autodoc.py`, which lives in `devel/sage/doc/common`, used to be a
simple modification of the Sphinx file `autodoc.py`, but now the two files
differ more dramatically as `autodoc.py` has been patched in ways that
`sage_autodoc.py` hasn't, and vice versa.
It might be good, to take full advantage of upgrades to Sphinx, to try to
remedy this by creating `sage_autodoc.py` by patching `autodoc.py` in the
Sphinx spkg. Unfortunately, when I tried this approach, the new
`sage_autodoc` module didn't work perfectly, probably because of recent
changes in `autodoc`. This could be dealt with on another ticket.
Following Leif's general suggestion about this kind of thing, perhaps we
should add a "To do" item to the "Special Build Instructions" section of
SPKG.txt. I've prepared a new spkg (based on yours) with this change.
The spkg also removes the patch to 'autodoc.py', since I don't think we
use that anymore: we use 'sage_autodoc.py' instead.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10620#comment:20>
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.
