#9128: Sphinx should be aware of all.py to find its links
-----------------------------+----------------------------------------------
Reporter: hivert | Owner: hivert
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-5.0
Component: documentation | Keywords: Sphinx links
Work_issues: | Upstream: N/A
Reviewer: | Author: Florent Hivert
Merged: | Dependencies: #11251, #12490
-----------------------------+----------------------------------------------
Comment(by hivert):
> I have been through the patch, and it looks reasonnable, though I am not
by far a Sphinx expert. Just a detail: several of the functions do not
have doctests. Now I am not sure if it is anyway really possible to
doctest them; if not, I guess that's ok as is.
Unfortunately, I've no idea how to doctests those. As you can see from the
code, I wrote my patch using log backtrace and {{{pdb}}}. At several
point,
I'm using call to sphinx or docutils internal which are not really
documented. So this is some kind of reverse engineering. I tried several
time
to ask for some help on sphinx-user and never got any answer on that. My
diagnostic is that Sphinx doesn't expose a sufficiently flexible API to
achieve what we want.
Probably a good solution would be to have a Sage-days whose subject is
Sphinx
and doc-compiling and invite George Brandl. We could also solve the Sphinx
parallel build ticket at the same occasion. Unfortunately, I just
organized a
Sage-days and I'm invited to two other until summer so I won't organize
such a
days and if organized, I don't think I'll be able to attend.
By the way, I'll CC this on Sage-devel.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9128#comment:42>
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.