在 python 文档字符串中包含文件中的文本

Question

我正在为 Python 包以

rst

格式编写文档字符串，其中一段文本在多个位置重复。我想将这个常见文本保存在一个单独的文件中，并将其包含在它出现的任何位置。这是为了使维护更容易。

请为此提出解决方案。

Answer 1

您可以使用

include

指令：

“include”指令读取文本文件。指令参数是要包含的文件的路径，相对于包含该指令的文档。除非给出选项文字、代码或解析器，否则文件将在指令所在的当前文档上下文中进行解析。例如：

.. include:: inclusion.txt