Re: [Epydoc-devel] =?utf-8?q?Docstring_parsing_II=3A_Links_between_fu?= =?utf-8?q?nctions=2Cargument_highlighting=3F?=

[Daniele V. <pi...@de...>]

On Fri, 11 May 2007 13:54:56 +0200, Hans Meine <me...@in...> wrote:

> Hi!

> 

> I would expect this to be a FAQ, but I could not find any evidence that

> epydoc

> supports automatic cross-referencing of function names?  It would be cool

> if

> refererences within docstrings to other functions or to function arguments

> were recognized and treated specially.



Cross linking is supported with the "L{name}" syntax in epytext docformat and with the default interpreted text role "`name`" in reST docformat. The reference produces a link in HTML output.



Do you mean by "automatic" that every word matching a function/class/variable name should automatically become a link? This would be ambiguous, at best, and woud produce a lot of wrong links.



-- 

Daniele Varrazzo - Develer S.r.l.

http://www.develer.com