Hi Andrey,

On Wed, Jun 02, 2010 at 05:05:51PM -0700, Andrey Novoseltsev wrote:
> While I have no ideas/suggestions on how to implement it, I think that
> it is highly desirable to have such a functionality. In addition to
> simplifying life of those who write doctests with links, it will help
> to make documentation more stable - if some classes/functions were
> moved around modules but were still exported through all.py, all
> references would remain accurate with automatic search rather than
> hardcoded direct links.

This is now #9128 where I just uploaded a much better prototype. It makes use
of the missing-reference API so there is no need to change sphinx itself. On
the contrary I only patch the file "conf.py". I've however a few design
question:

- Should we search the link in all.py or in the local module ? In the latter
solution we can only link what is imported in the current module, keeping the
doc coherent with the module.

- I can also take the chance to raise warning for really dangling links if
needed. Maybe this should be configurable by an environment variable, say
SAGE_DOC_WARN_DANGLING_LINKS.

Any ideas or suggestions ?

Cheers,

Florent

-- 
To post to this group, send an email to [email protected]
To unsubscribe from this group, send an email to 
[email protected]
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org

Reply via email to