如何链接/引用文档中的另一个 reST 文件？

小开

最佳答案

为了引用其他文件，我必须在 conf.py中包含以下内容。我从枕头(PIL 叉子) 给你的文档中获取了代码。

extensions = ['sphinx.ext.intersphinx']

我认为狮身人面像之间的扩展对我有帮助，它链接了其他文档页面。

小开

创建不同 ReStructuredText 之间的链接(。Rst)文件，您可以使用 sphinx 提供的内联标记。标题下的请参阅文档

在文件的顶部定义它的标签

.. _my-reference-label:

然后您可以使用

:ref:`my-reference-label`.

我不认为您需要使用 intersphinx 扩展，因为它用于不同项目之间的链接。使用这种方法，您可以在不同的。Rst 文件使用它们的相对路径，如上面的文档链接所述。

小开

我使用以下方法编写到另一个文档的链接:

:doc:`my document <../my_doc>`

../my_doc是我的 my_doc.rst文件的路径。

在 conf.py文件中还有 intersphinx 扩展名。

extensions = ['sphinx.ext.intersphinx']

小开

简化@me-me 的回答，你可以这样做:

:doc:`path/to/document`

您不需要在 < > 中包含路径并提供要显示的文本。在这种情况下，引用文档的顶级标题将显示为链接。

你不需要狮身人面像之间的扩展。

小开

现有文件{ example.rst }可以按照以下语法链接:

:ref:`Optional Link text <example>`

然而，把它放在一个主题或者甚至一个要点中，行为可能会改变。因此，您可以参考最终构建的文件:

`Optional Link text <example.html>`_

小开

从一个页面链接(。Rst 文件)添加到另一个页面(不同的。Rst 文件)使用以下内联格式:

See :ref: `topLevelHeadingofOtherPage`

例如:

See :ref:`Perform Bulk Actions`.

就是这样。我同意，这个信息很难在狮身人面像指南中找到。这是因为它太简单了，我想人们会认为你想要做一些更复杂的事情。

小开

为了引用标题，需要在 conf.py中添加这个扩展:

   extensions = [
'sphinx.ext.autosectionlabel',
]

那就用 :ref:`Any heading in the project` 。