如何在阅读文档时在多个页面上显示冗余文档

Question

在我们阅读docs项目中，我们有一个用例，我们需要在同一版本的docs中的多个页面上显示一些特定的文档。截至目前，我们通过以下方式之一做到这一点

• 将内容复制粘贴到每个页面的rst文件
• 使用标签将其写入其中一个相关文件，并在其余文件中使用:std:ref:将其重定向到主文件

我希望实现类似于在一个文件中编写内容然后在每个文件中显示它（不对用户进行任何重定向）的操作。有可能吗？

Answer 1

使用父文件中的include directive。

.. include:: includeme.rst

请注意，包含的文件将在父文件的上下文中解释。因此，包含文件中的节级别（标题）必须与父文件一致，并且包含文件中的标签可能会生成重复警告。

Answer 2

您可以将include directive用于此目的。

假设您在dir/text.rst中写下了文字。

以下内容将包括在其他文件中：

..include :: /dir/text.rst

其中路径是相对的（然后，没有斜线）或绝对值，这在sphinx（doc）

中是可能的

  

在Sphinx中，当给出一个绝对包含文件路径时，该指令   将其作为相对于源目录的