包括python-sphinx生成的文档中的动态内容

Question

我正在使用sphinx为我的项目生成文档，并在产品的安装过程中构建文档。我想动态地在文本和/或代码块中包含主机名。我没有在文档中看到任何解释包括shell命令输出或特定文件中特定行以外的任何设施的任何解释。这种能力是否存在？

Answer 1

以下是两个可以执行此操作的Sphinx extensions：

• autorun：在runblock指令中执行Python代码，捕获输出并将其插入到文档中。
• programoutput：使用program-output指令执行任意命令，并将输出插入到文档中。