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

Question

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

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

请你也可以参考一个很好的资源，从那里我可以查找语法的休息。默认的快速启动有点无聊，并不涉及使用狮身人面像休息的深度讨论。

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

Answer 1

要referecnce其他文件我必须包括在conf.py以下。我从Pillow（PIL fork）here的文档中获取代码。

extensions = ['sphinx.ext.intersphinx'] 

我认为狮身人面像的扩展来帮助我。它链接到其他文档页面。

Answer 2

要创建不同reStructuredText（.rst）文件之间的链接，您可以使用sphinx提供的内联标记。 See the documentation的标题下，交叉引用文件上的文件的顶部

定义使用

:doc:`my-reference-label`. 

我不知道它的标签

.. _my-reference-label: 

那么你可以从其他文档链接到它相信你需要使用intersphinx扩展，因为它用于不同项目之间的链接。使用这种方法，您可以使用它们的相对路径在不同的.rst文件之间进行链接，如上面的文档链接中所述。