如何在restructuredtext中创建指向标题的链接?

时间:2018-02-20 15:23:28

标签: restructuredtext

我在重组测试中有一个文档,如:

Header 1
========

以及其他任何一点(可能是相同的'第一个'文件或不同的文件)我想创建一个指向该标题的超链接。因此,当用户点击它时,他会转到带有标题Header 1

的页面

怎么做?

我尝试将以下行放在另一个文档中(根据this documentation):

see :ref:`Header 1`

但我得到的是以下内容:

see Header 1

没有任何链接......

我也尝试关注this documentation

我在rst文件中输入的内容如下

see `Header 1`_

我所看到的是以下链接:

see `Header 1`_

看起来不太好......

2 个答案:

答案 0 :(得分:2)

你的第一个链接几乎是正确的。您需要在节标题前面添加一个标签,用空行分隔。请参阅Inline markup, Cross-referencing arbitrary locations, using the :ref: directive

在你的情况下:

.. _header-1-label-name:

Header 1
========

Some text

Here is a section reference: :ref:`header-1-label-name`.

Here is a section reference with a title: :ref:`Header 1 with a title <header-1-label-name>`.

答案 1 :(得分:0)

除了accepted answer之外,您添加的标签(在本例中为.. _header-1-label-name:)还必须带有破折号。因此,简单的.. _label:不会起作用。花了我一段时间才能弄清楚。