#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-4.4.4
Component: documentation | Keywords: Sphinx links
Author: Florent Hivert | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
------------------------------+---------------------------------------------
Comment(by hivert):
Replying to [comment:16 novoselt]:
> I think that I want to have a distinction between "totally wrong names"
and names which were successfully found in the Sage library (therefore, it
makes sense to reference them), but do not have corresponding entries in
the documentation files (therefore, it is not possible to convert them
into a working hyperlink). Private/underscore methods are one example (I
would like actually to seem them in the documentation "on demand", but
maybe there are arguments against it), another is reference to objects in
modules which are not included into documentation (maybe there will be no
such modules eventually). I hope this is more clear, but in any way it is
a small point.
This should be exactly what I'm doing: I issue two different kinds of
warning:
- {{{undefined symbol :%s:`%s` in %s}}}
- {{{symbol :%s:`%s` linked from %s is defined in %s but not
documented}}}
Bu maybe sometime I fail finding a symbol and therefore issue the first
warning instead of the second one... Is this happening for you ?
Florent
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9128#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.
