如何在重组文本中创建 link 到 header？

Question

我在 restructuredtest 中有一个文档，例如：

Header 1
========

并且从任何其他点（可能是相同的 'rst' 文件或不同的文件）我想为那个 header 创建一个 hyperlink。这样当用户点击它时，他会进入带有 header Header 1

的页面

怎么做？

我试图将以下行放在其他文档中（根据 this documentation）：

see :ref:`Header 1`

但我得到的是以下内容：

see Header 1

没有任何 link...

我也试过关注this documentation:

我放入rst文件的内容如下

see `Header 1`_

我看到的是下面的link:

see `Header 1`_

看起来不太好看...

Answer 1

您的第一个 link 几乎是正确的。您需要在 header 部分之前添加标签，并用空行分隔。参见 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>`.

Answer 2

除了 之外，您添加的标签（在本例中为 .. _header-1-label-name:）还需要有破折号。所以一个简单的 .. _label: 是行不通的。我花了一段时间才弄明白。