我根本不知道如何链接到reST文件中的其他文档。
我想将名为install.rst的文件链接到段落中的快速入门指南。我不知道如何实现这一目标。
请你也可以参考一个很好的资源，从那里我可以查找语法休息。默认的快速入门有点无聊，并没有涉及使用sphinx休息的深入讨论。
相关文档是：http://todx.rtfd.io
答案 0 :(得分：23)
要在不同的reStructuredText（.rst）文件之间创建链接，您可以使用sphinx提供的内联标记。标题交叉引用文档
下的See the documentation在文件顶部定义其标签
.. _my-reference-label:
然后您可以使用
从其他文档链接到它:ref:`my-reference-label`.
我认为您不需要使用intersphinx扩展，因为它适用于不同项目之间的链接。使用此方法，您可以使用其相对路径在不同的.rst文件之间进行链接，如上面的documentaion链接所述。
答案 1 :(得分：14)
我使用以下方法将链接写到另一个文档：
:doc:`my document <../my_doc>`
../my_doc是my_doc.rst文件的路径。
我的conf.py文件中也有inter-sphinx扩展名。
extensions = ['sphinx.ext.intersphinx']
答案 2 :(得分：0)
简化@ eme-eme的答案，您可以这样做：
:doc:`path/to/document`
您不需要将路径包含在<>中并提供要显示的文本。在这种情况下，所引用文档的顶级标题将显示为链接。
您不需要狮身人面像之间的扩展。
答案 3 :(得分：0)
可以使用以下语法链接到现有文件 {example.rst}：
:ref:`Optional Link text <example>`
但是，将其放入主题甚至项目符号中，行为可能会改变。所以，你可以参考最终构建的文件：
`Optional Link text <example.html>`_
这是一个great guide
答案 4 :(得分：0)
要将项目中的一个页面（.rst 文件）链接到另一个页面（不同的 .rst 文件），请使用以下内联格式：
See :ref: `topLevelHeadingofOtherPage`
例如：
See :ref:`Perform Bulk Actions`.
就是这样。我同意，在 Sphinx 指南中很难找到这些信息。因为它太简单了，我认为人们认为你想做更复杂的事情。
答案 5 :(得分：-2)
要引用其他文件，我必须在conf.py中包含以下内容。我从Pillow（PIL fork）here的文档中获取了代码。
extensions = ['sphinx.ext.intersphinx']
我认为跨狮身人面像扩展得到了我的帮助。它与其他文档页面相关联。