我如何 link/reference 文档中的另一个 reST 文件?

How can I link/reference another reST file in the documentation?

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

我想 link 一个名为 install.rst 的文件到我的快速入门指南中的一个段落。我不知道我怎样才能做到这一点。

请您也参考一个很棒的资源,我可以从中查找休息语法。默认的 quickstart 有点无聊,没有深入讨论将 rest 与 sphinx 结合使用。

相关文档是:http://todx.rtfd.io

要引用其他文件,我必须在 conf.py 中包含以下内容。我从 Pillow(PIL fork) here.

的文档中获取了代码
extensions = ['sphinx.ext.intersphinx']

我认为 inter-sphinx 扩展对我有所帮助。它链接到其他文档页面。

要在不同的 reStructuredText (.rst) 文件之间创建 link,您可以使用 sphinx 提供的内联标记。 See the documentation 标题下 Cross-referencing 文档

在文件顶部定义其标签

.. _my-reference-label:

然后您可以使用

从其他文档link到它
:ref:`my-reference-label`.

我认为您不需要使用 intersphinx 扩展,因为它用于不同项目之间的 links。使用此方法,您可以 link 在不同的 .rst 文件之间使用它们的相对路径,如上面的文档 link 中所述。

我使用这个将 link 写入另一个文档:

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

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

我的 conf.py 文件中也有 inter-sphinx 扩展名。

extensions = ['sphinx.ext.intersphinx']

简化@eme-eme的回答,你可以这样做:

:doc:`path/to/document`

您无需将路径括在 <> 中并提供要显示的文本。在这种情况下,引用文档中的 top-level header 将显示为 link.

您不需要 inter-sphinx 扩展。

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

:ref:`Optional Link text <example>`

但是,将其放入主题甚至要点中,行为可能会改变。所以,你可以参考最终构建的文件:

`Optional Link text <example.html>`_

这是一个great guide

要 link 从项目中的一页(.rst 文件)到另一页(不同的 .rst 文件),请使用以下内联格式:

See :ref: `topLevelHeadingofOtherPage`

例如:

See :ref:`Perform Bulk Actions`.

就是这样。我同意,在 Sphinx 指南中很难找到此信息。这是因为它太简单了,我认为人们会假设您想做一些更复杂的事情。