跳转到主要内容

Sphinx扩展,用于包含程序输出

项目描述

https://sphinxcontrib-programoutput2.readthedocs.org

一个 Sphinx 扩展,用于直接将任意命令的输出插入文档中,帮助您保持命令示例的最新性。

安装

PyPI 安装此扩展

pip install sphinxcontrib-programoutput2

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

用法

只需将此扩展添加到 extensions

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 查看哈希值)

上传时间

构建分发

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

上传时间 Python 3

支持