sphinxcontrib-programoutput 0.17

安装

从 PyPI 安装此扩展

pip install sphinxcontrib-programoutput

此扩展需要 Sphinx 1.7.0 和 Python 2.7 或 Python 3（已测试 Python 3.6+）至少。

使用

只需将此扩展添加到 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.17 (2021-03-31)

• 添加对Python 3.9的支持。

• 停止支持python 3.5。

• 当程序返回意外的返回代码时，将程序输出和当前工作目录包含在记录的警告中。由Sorin Sbarnea建议。参见问题50。

0.16 (2020-03-23)

• 添加name和caption选项。由Raphaël在PR 41中添加。

• 添加对Python 3.8的支持。

0.15 (2019-09-16)

• 测试套件不再假设路径上存在名为‘python’的可执行文件。相反，它使用sys.executable（不应该包含空格）。注意，它仍然假设其他可执行文件的存在，例如‘echo’。由John Vandenberg在问题38中报告。

0.14 (2019-04-08)

• 添加python_requires元数据，以更好地允许工具如pip安装正确版本。

• 在Python 3上添加对Sphinx 2.0的支持。

• 当程序命令或输出产生非ASCII输出且配置的提示为字节数组时，避免Unicode错误。这很可能是在Python 2下，其中默认配置的提示是字节数组。由latricewilgus报告，补丁灵感来自问题33。

0.13 (2018-12-22)

• 停止支持Sphinx < 1.7。

• 修复Sphinx >= 1.8.0上的测试。

• 从Sphinx >= 1.8.0b1失败的程序运行中恢复错误消息。

• 修复Sphinx >= 1.8上的弃用警告。由miili在问题29中报告。

0.11 (2017-05-18)

• 在扩展元数据中显式设置parallel_read_safe为true。参见问题25。感谢Adam J. Stewart和Stephen McDowell。

0.10 (2017-03-17)

• 使用“replace”处理程序宽恕地解码输出。基于Stefan C. Müller的拉取请求。

0.9 (2017-03-15)

• 在Gitub上分支并重振该项目。

• 在Travis CI上运行测试。格式和样式由pylint强制执行。

• 目前支持的最老和测试过的Sphinx版本是1.3.5。参见问题17。

• 移除对Python 2.6、Python 3.2和3.3的支持。

• 100%测试覆盖率。

• 移除对programoutput_use_ansi的支持。由于sphinxcontrib.ansi扩展不再在PyPI上提供。

0.8（2012年10月12日）

• 迁移到GitHub

0.7（2012年4月17日）

• 向..program-output添加cwd选项

• 现在，执行程序的工作目录默认为文档根目录

0.6（2012年1月7日）

• 添加对Python 3的支持

• 现在需要Sphinx 1.1

0.5（2011年9月19日）

• programoutput_prompt_template现在被解释为格式字符串！

• 现在需要Python 2.6

• 向program-output添加returncode选项（感谢Jan-Marek Glogowski）

• 支持programoutput_prompt_template中的returncode格式化键

• 在出现意外的返回代码时发出警告，而不是抛出subprocess.CalledProcessError

• 将命令期间的致命错误转换为文档错误消息，而不是崩溃构建

0.4.1（2011年3月11日）

• 一些源代码清理

• 修复文档中的安装说明

0.4（2010年5月21日）

• 首次发布