为 Sphinx 文档重用 RST 中的文本答案

【问题标题】：Reusing text in RST for Sphinx Documentation为 Sphinx 文档重用 RST 中的文本
【发布时间】：2017-06-15 07:26:45
【问题描述】：

我正在编写 RST 格式的文档并使用 Sphinx 生成 HTML。

我希望能够在 RST 文件中编写一个段落，并在同一文件夹中的不同 RST 文件中重复使用相同的段落。我想要重用，这样如果我在原始段落中进行更改，它应该在我使用 Sphinx 生成 HTML 时自动更改它已引用的所有其他文件。

是否有任何 RST 语法可以实现这一点？任何帮助表示赞赏。

【问题讨论】：

【解决方案1】：

您可以使用include directive。

对于基本包含，请参考您要重复使用的段落，如下所示：

Some text

.. include:: /path/to/file_to_include.rst

More text

在我们的示例中，file_to_include.rst 的内容是Included text。 Sphinx 将生成：

Some text

Included text

More text

正如您在 docutils 文档（如上链接）中所见，您可以选择指定一组选项，例如将包含的文本限制为一系列行。

【讨论】：

谢谢！我可以添加完整的文本，也可以添加起始行或结束行。但是，当我将起始行和结束行都添加为参数以显示范围时，它不会显示出来。这是我正在使用的语法： .. include:: includedtext.rst :start-line: 11 :end-line: 14
它对我来说很好用。您能否链接到一个示例项目，我可以通过该项目重现该问题并提供您的 Sphinx/Docutils 版本？您确定您正确指定了行号吗？行数从 0 开始。不包括“end-line”。