Skip to main content

包含程序输出的 Sphinx 扩展

项目描述

https://sphinxcontrib-programoutput2.readthedocs.org

一个Sphinx扩展,可将任意命令的输出逐字插入文档中,帮助您使命令示例保持最新。

安装

从PyPI安装这个扩展:

pip install sphinxcontrib-programoutput2

该扩展需要 Sphinx 3.0.0 和 Python 3.6 或更高版本。

用法

只需将此扩展添加到扩展中:

extensions = ['sphinxcontrib.programoutput']

现在你有两个新指令program-outputcommand-output来插入程序的输出。前者只是插入输出:

.. program-output:: python -V

输出:

Python 3.9.0

后一个指令模拟了一个 shell 会话,旨在展示示例:

.. command-output:: python -V

输出:

$ python -V
Python 3.9.0

有关此扩展的使用和配置的全面信息,请参阅文档。

发展和支持

有关支持和开发过程的信息,请参阅文档

下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

sphinxcontrib-programoutput2-2.0a1.tar.gz (28.4 kB 查看哈希)

已上传 source

内置分布

sphinxcontrib_programoutput2-2.0a1-py3-none-any.whl (25.6 kB 查看哈希

已上传 py3