包含程序输出的 Sphinx 扩展
项目描述
sphinxcontrib 程序输出
https://sphinxcontrib-programoutput.readthedocs.org
一个Sphinx扩展，可将任意命令的输出逐字插入文档中，帮助您使命令示例保持最新。
安装
从PyPI安装这个扩展：
pip install sphinxcontrib-programoutput
该扩展至少需要 Sphinx 1.7.0 和 Python 2.7 或 Python 3（已测试 Python 3.6+）。
用法
只需将此扩展添加到扩展中：
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 的支持。
当程序返回意外返回代码时，在记录的警告中包括程序输出和当前工作目录。由索林·斯巴尼亚建议。见第 50 期。
0.16 (2020-03-23)
添加名称和标题选项。 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)
使用“替换”处理程序以宽容的方式解码程序的输出。基于 Stefan C. Müller 的拉取请求 。
0.9 (2017-03-15)
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
为程序输出添加了返回码选项（感谢 Jan-Marek Glogowski）
支持programoutput_prompt_template中的returncode格式化键
警告意外的返回代码而不是引发 subprocess.CalledProcessError
将命令期间的致命错误转换为文档错误消息，而不是使构建崩溃
0.4.1（2011 年 3 月 11 日）
一些源代码清理
修复了文档中的安装说明
0.4（2010 年 5 月 21 日）
初始发行
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
内置分布
sphinxcontrib -programoutput-0.17.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 300ee9b8caee8355d25cc74b4d1c7efd12e608d2ad165e3141d31e6fbc152b7f |
|
| MD5 | 7bad912b0af6bb504819659ffe382199 |
|
| 布莱克2-256 | 49fe8a6d8763674b3d3814a6008a83eb8002b6da188710dd7f4654ec77b4a8ac |
sphinxcontrib_programoutput -0.17-py2.py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 0ef1c1d9159dbe7103077748214305eb4e0138e861feb71c0c346afc5fe97f84 |
|
| MD5 | 97ee90a39f03be83320bca30c7d202f0 |
|
| 布莱克2-256 | 30eeb7be4b3f45f4e36bfa6c444cd234098e0d09880379c67a43e6bb9ab99a86 |