包含命令输出的Sphinx扩展
sphinxcontrib-commandoutput的Python项目详细描述
SphinxControl程序输出
https://sphinxcontrib-programoutput.readthedocs.org
一个Sphinx扩展，可以直接将任意命令的输出插入到 文档，帮助您保持命令示例的最新状态。在
安装
从PyPI安装此扩展：
pip install sphinxcontrib-programoutput
扩展需要Sphinx1.7.0和Python2.7或Python3（Python 3.5+测试）至少。在
用法
只需将此扩展添加到extensions：
^{pr2}$现在有两个新指令program-output和command-outputto 插入程序的输出。前者只是插入输出：
.. program-output:: python -V
输出：
Python 2.7.1
后一个指令模拟shell会话，旨在显示示例：
.. command-output:: python -V
输出：
$ python -V Python 2.7.1
请参考documentation了解有关使用和 此扩展的配置。在
开发和支持
有关支持和 开发过程。在
变更
0.17（2020-03-09）
- 从sphinxcontrib-programoutput分叉。在
- 重命名为sphinxcontrib-commandoutput。在
0.16（未释放）
- 什么都没变。在
0.15（2019-09-16）
- 让测试套件停止假设“python”的存在 路径上的可执行文件。相反，它使用sys.executable（它 不应该有空格）。注意，它确实继续假设 存在其他可执行文件，如“echo”。在issue 38中报告 作者：约翰·范登伯格。在
0.14（2019-04-08）
- 添加python_requires元数据以更好地支持^{tt7}等工具$ 安装正确的版本。在
- 在Python3上添加对Sphinx2.0的支持。在
- 在生成程序命令或输出时避免unicode错误 非ASCII输出，配置的提示为字节字符串。这个 很可能是在python2下，其中默认配置的提示符 是字节字符串。报告人和patch灵感来源于issue 33 拉特里塞维格斯。在
0.13（2018-12-22）
- 对狮身人面像1.7的下降支架。在
- 在Sphinx上修复测试>；=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”对程序的输出进行足够的解码 处理程序。基于pull request 作者：Stefan C.Müller。在
0.9（2017-03-15）
0.8（2012年10月12日）
- 迁移到GitHub
0.7（2012年4月17日）
- 将cwd选项添加到..program-output
- 执行程序的工作目录现在默认为documentation root
0.6（2012年1月7日）
- Python 3支持
- 现在需要Sphinx 1.1
0.5（2011年9月19日）
- programoutput_prompt_template现在被解释为格式字符串！在
- 现在需要Python2.6
- 将returncode选项添加到program-output（感谢 简·马雷克·格洛戈夫斯基）
- 支持returncode格式化键 programoutput_prompt_template
- 出现意外返回代码时发出警告饲养学 subprocess.CalledProcessError
- 在执行命令期间，文档消息会变成致命错误 而不是破坏建筑
0.4.1（2011年3月11日）
- 一些源代码清理
- 文件中的固定安装说明
0.4（2010年5月21日）
- 初次发行
- 项目
标签：
欢迎加入QQ群-->： 979659372
