在RST中重用Sphinx文档中的文本

时间:2017-01-30 07:28:55

标签: documentation python-sphinx restructuredtext

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

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

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

1 个答案:

答案 0 :(得分:2)

您可以使用get

对于基本包含,请参考您要重用的段落,如下所示:

Some text

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

More text

在我们的示例中,file_to_include.rst的内容为Included text。 狮身人面像会产生:

Some text

Included text

More text

正如您在docutils文档(上面链接)中所看到的,您可以选择指定一组选项,例如将包含的文本限制为一系列行。