如何链接/引用文档中的其他reST文件？

Question

我根本不知道如何链接到reST文件中的另一个文档.

我想install.rst在段落中链接一个名为我的快速入门指南的文件.我不知道如何实现这一目标.

请你也可以参考一个很好的资源,从那里我可以查找语法休息.默认的快速入门有点无聊,并没有涉及使用sphinx休息的深入讨论.

有问题的文件是:http://todx.rtfd.io

Answer 1

要在不同的reStructuredText(.rst)文件之间创建链接,您可以使用sphinx提供的内联标记.请参阅" 交叉引用文档 "标题下的文档

在文件顶部定义其标签

.. _my-reference-label:

然后你可以使用其他文件链接到它

:ref:`my-reference-label`.

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

Answer 2

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

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

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

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

extensions = ['sphinx.ext.intersphinx']

Answer 3

简化@ eme-eme的答案，您可以这样做：

:doc:`path/to/document`

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

您不需要为此的狮身人面像扩展。

Answer 4

要引用其他文件，我必须在conf.py. 我从这里的 Pillow(PIL fork) 文档中获取了代码。

extensions = ['sphinx.ext.intersphinx']

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