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

我完全不知道如何链接到reST文件中的另一个文档

我想在段落中将名为

install.rst

的文件链接到我的快速入门指南。我不知道如何才能做到这一点

请您也参考一个很好的资源，我可以从中查找rest的语法。默认的快速入门有点枯燥，并且不涉及将rest与sphinx一起使用的深入讨论

---

所讨论的文档是：

要引用其他文件，我必须在

conf.py

中包含以下内容。我从枕头（PIL fork）的文档中获取了代码

---

我想国际狮身人面像的扩建对我有帮助。它跨其他文档页面链接。

要在不同的StructuredText（.rst）文件之间创建链接，可以使用sphinx提供的内联标记。在标题下，交叉引用文件

在文件顶部定义其标签

.. _my-reference-label:

然后，您可以使用从其他文档链接到它

:ref:`my-reference-label`.

---

我不认为您需要使用intersphinx扩展，因为它用于不同项目之间的链接。使用此方法，您可以使用上述文档链接中所述的相对路径在不同的.rst文件之间进行链接。

我使用以下方法将链接写入另一个文档：

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

---

简化@eme-eme的答案，您只需执行以下操作：

:doc:`path/to/document`

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

---

您不需要使用inter sphinx扩展名。

现有文件{example.rst}可以使用以下语法链接到：

：ref:`可选链接文本`

然而，把它放在一个话题甚至一个要点中，行为可能会改变。因此，您可以参考最终生成的文件：

`可选链接文本`_

---

这是一个

请您也描述一下如何将链接写入其他文档？使用标签时，它应该是

：ref:

，而不是

：doc:

。对于

：doc:

，您需要指定另一个文件的名称，而不是标签。我强烈反对这种解决方案：除了初始注释之外，任何元素都不应位于文档标题之前，因为许多渲染器都依赖于此。例如，文档开头的标签可能会影响sphinx主题的导航链接。除此之外，当问题是如何链接到文档而不是文档中的任意位置时，答案过于具体。页眉标签/目标不必位于页面顶部。事实上，您可能在一个文件中有多个，例如，每个部分一个，这样您就可以直接链接到此文件。我相信通常会将其直接放在标题（例如标题或章节标题）之前，请参阅，如果链接到同一项目中的文档，则不需要使用intersphinx扩展名。您链接到的TYPO3备忘单中有一些特定于TYPO3的内容，用于呈现TYPO3中的文档。例如，我认为Settings.cfg是特定的。除此之外，这是一个很好的资源。但我会链接到一般的StructuredText/sphinx文档，例如，如果你想链接到不同的手册，请查找“intersphinx”。

extensions = ['sphinx.ext.intersphinx']

:doc:`path/to/document`