在 Python Sphinx 生成的文档中包含动态内容

Question

我正在使用 Sphinx 为我的项目生成文档，并将文档构建为产品安装过程的一部分。

我想在文本和/或代码块中动态包含主机名。我没有在文档中看到任何解释，也没有看到任何包含 shell 命令输出或特定文件中特定行以外的任何内容的工具。有这个功能吗？

Answer 1

这里有两个 Sphinx extensions 可以做到这一点：

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