sphinx扩展，包括程序输出
sphinxcontrib-programoutput的Python项目详细描述
SphinxContrib程序输出
https://sphinxcontrib-programoutput.readthedocs.org
一个Sphinx扩展，用于将任意命令的输出直接插入 文档，帮助您更新命令示例。
安装
从PyPI：
安装此扩展pip install sphinxcontrib-programoutput
扩展需要sphinx 1.7.0和python 2.7或python 3（python 3.5+测试）。
使用量
只需将此扩展添加到extensions：
extensions = ['sphinxcontrib.programoutput']
现在有两个新的指令program-output和command-output到 插入程序输出。前者只是插入输出：
.. program-output:: python -V
输出：
Python 2.7.1
后一个指令模拟shell会话，旨在显示示例：
.. command-output:: python -V
输出：
$ python -V Python 2.7.1
有关用法和 此扩展的配置。
开发和支持
有关支持和 发展进程。
更改
0.14（2019-04-08）
- 添加python_requires元数据以更好地允许像^{tt5}这样的工具$ 安装正确的版本。
- 在python 3上添加对sphinx 2.0的支持。
- 在生成程序命令或输出时避免Unicode错误 非ascii输出，配置的提示是字节字符串。这个 最有可能是在python 2下，其中默认的配置提示 是一个字节字符串。报告者和补丁的灵感来自issue 33 拉特里塞维格斯。
0.13（2018-12-22）
- 放下狮身人面像支架<；1.7。
- 在狮身人面像上修复测试>；=1.8.0。
- 默认情况下，将错误消息从失败还原到文档中 程序在sphinx上运行>；=1.8.0b1。
- 修复sphinx上的弃用警告>；=1.8。在issue 29中报告 米莉。
0.11（2017-05-18）
- 在扩展中显式地将parallel_read_safe设置为true 元数据。见issue 25。 感谢亚当·J·斯图尔特和斯蒂芬·麦克道尔。
0.10（2017-03-17）
- 使用“replace”对程序输出进行适度解码 处理程序。基于apull request 作者：斯特凡·穆勒。
0.9（2017-03-15）
0.8（2012年10月12日）
- 迁移到GitHub
0.7（2012年4月17日）
- 已将cwd选项添加到..program-output
- 已执行程序的工作目录现在默认为文档根目录
0.6（2012年1月7日）
- python 3支持
- 现在需要Sphinx 1.1
0.5（2011年9月19日）
- programoutput_prompt_template现在被解释为格式字符串！
- 现在需要python 2.6
- 将returncode选项添加到program-output（感谢 Jan Marek Glogowski）
- 支持中的returncode格式化键 programoutput_prompt_template
- 意外返回代码时发出警告，而不是引发 subprocess.CalledProcessError
- 将命令期间的致命错误转换为文档错误消息 而不是破坏构建
0.4.1（2011年3月11日）
- 一些源代码清理
- 文档中的固定安装说明
0.4（2010年5月21日）
- 初始版本
欢迎加入QQ群-->： 979659372
