python-sphinx - Sphinx 文档：错误：未知指令类型“程序输出”

Question

我正在尝试使用 Sphinx 创建我的文档，现在在两台机器上我遇到了完全相同的问题：程序输出指令不起作用。

我安装了 Sphinx，然后是程序输出扩展：

$ sudo pip install sphinxcontrib-programoutput

安装很顺利，文档可以很好地编译成漂亮的 html，但是命令输出不起作用。

我创建了一个超级简单的测试用例，test.rst其中包含一个名为的文件，其中包含一行：

.. program-output:: python -V

现在，当尝试编译它时，我得到以下输出（路径缩写）：

/path/to/test.rst:1: ERROR: Unknown directive type "program-output".

将程序输出更改为其别名命令输出也不起作用（不足为奇）。我真的想知道我在这里做错了什么。我按照安装说明，一次又一次地尝试，重新安装了一个--upgrade标志，没有任何效果。

Answer 1

感谢bmu，我发现了问题，确实我不得不将它添加到conf.py中。

现在下一个问题：“为什么这不在此扩展的安装/使用文档中？” http://packages.python.org/sphinxcontrib-programoutput/中没有提到它，这是我在谷歌搜索这个扩展时得到的第一个链接。

无论如何，完整的答案，希望它对其他人也有用：

~/Projects/project-name/doc转到其余文档所在的文档的文档根目录（例如）。

编辑文件conf.py

查找显示的行extensions = []（在我的情况下是一个空列表）

将其更改为：extensions = ['sphinxcontrib.programoutput']

奇迹般地它突然开始起作用了。