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

时间:2012-10-11 14:45:51

标签: python-sphinx

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

我安装了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标志,没有任何作用。

1 个答案:

答案 0 :(得分:4)

感谢bmu我发现了问题,实际上我必须将它添加到conf.py。

现在接下来的问题是:“为什么这不在此扩展的安装/使用文档中?”在http://packages.python.org/sphinxcontrib-programoutput/中没有提到这是我在Google上搜索此扩展程序时获得的第一个链接。

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

转到文档的文档根目录(例如~/Projects/project-name/doc),其中包含其他文档。

修改档案conf.py

查找显示extensions = []的行(我的情况下为空列表)

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

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