[SciPy-dev] Does the doc wiki have a format for internal links...

Ralf Gommers ralf.gommers@googlemail....
Tue Jan 5 05:19:15 CST 2010


On Tue, Jan 5, 2010 at 7:35 AM, David Goldsmith <d.l.goldsmith@gmail.com>wrote:

> ...similar to the external link format?  For example, at a certain place I
> want the word "broadcasting" to be a link to numpy.doc.broadcasting - do I
> have to use the external format `broadcasting <
> http://docs.scipy.org/numpy/docs/numpy.doc.broadcasting/>`_ (which does
> work) or is there some variant of `numpy.doc.broadcasting` (which does
> correctly point there, but w/out the desired text replacement) I can use?


Not that I know of. This can go on the wishlist, next to anchor links.
Please don't use hardcoded links like the example you give above, that will
break if the docs are restructured. For now I'd use something like:
broadcasting (see `numpy.doc.broadcasting`)


>   (I tried the obvious `broadcasting numpy.doc.broadcasting` both with and
> without a trailing "_", but neither worked, (and beyond that, the number of
> variants to "just try" is excessive) and I looked at the rst quickref, but
> it wasn't helpful and in any event, linking w/in our Wiki is a
> specialization enabled by pydocweb, yes?)
>

Yes.

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20100105/1d8ac459/attachment.html 


More information about the SciPy-Dev mailing list