如何链接/引用文档中的另一个 reST 文件? [英] How can I link/reference another reST file in the documentation?

问题描述

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

I have simply no idea on how can I link to another document in the reST file.

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

I want to link a file named install.rst to my quickstart guide in a paragraph. I don't know how can I achieve this.

请您还可以参考一个很好的资源，我可以从中查找语法以供休息.默认的快速入门有点乏味，并且没有深入讨论将 rest 与 sphinx 结合使用.

Please can you also refer to a great resource from where I can look up syntax for rest. The default quickstart is a little boring and not involves great depth discussion of using rest with sphinx.

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

推荐答案

为了引用其他文件，我必须在 conf.py 中包含以下内容.我从 Pillow(PIL fork) 此处的文档中获取了代码.

To referecnce other files I had to include the following in the conf.py. I took the code from the docs of Pillow(PIL fork) here.

extensions = ['sphinx.ext.intersphinx']

我认为狮身人面像间的扩展对我有所帮助.它链接到其他文档页面.

I think the inter-sphinx extension came to my help. It linked across the other doc pages.

这篇关于如何链接/引用文档中的另一个 reST 文件?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！