reST:带有任意标题的内联链接?

时间:2011-04-20 20:50:19

标签: python documentation restructuredtext

如果我已定义内部超链接目标,如何使用任意文本作为链接标题链接到它?

例如:

_`This is a very long internal link target`.

...

A `short reference`_ to the very long link target.

我怎样才能将“短引用”定位为“非常长的内部目标”?

修改:另一个例子:

Widgets
=======

...

Use a `widget`_.

如何将“widget”(单数)链接到“Widgets”(复数)标题?

(当然,我意识到这可以使用`widget`_\s来完成......但这并不能解决一般问题)

3 个答案:

答案 0 :(得分:4)

我还没有找到使用“标准”reST的方法。但是使用Sphinx,以下工作:

.. _`This is a very long internal link target`:

:ref:`Short reference <This is a very long internal link target>` to the very long link target.

答案 1 :(得分:2)

很好,mzjn's answer也适用于课程:

:class:`MyClasses <mymodule.MyClass>` in plural is awesome.

乌拉!

答案 2 :(得分:0)

pure-reStructuredText方法是为同一目标定义多个目标名称:

.. _my widget:
.. _above:
My long title about widgets
===========================
…
See how to use  `my widget`_ in the section above_.

(这种方法的局限在于您可能希望将相同的文本(例如“上方”)用于两个不同的位置,并且上述方法失败了这种情况。)