Sphinx文档:错误:未知指令类型"程序输出"

Question

我正在尝试使用Sphinx创建我的文档,现在在两台机器上我遇到了完全相同的问题:program-output指令不起作用.

我安装了Sphinx,然后是programoutput扩展:

$ sudo pip install sphinxcontrib-programoutput

安装很顺利,文档编译得很漂亮,但是命令输出不起作用.

我创建了一个超简单的测试用例,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']

奇迹般地，它突然开始发挥作用。