跳转到主要内容

Sphinx扩展自动运行

项目描述

sphinx-autorun 是一个用于 Sphinx 的扩展,可以执行 runblock 指令中的代码,并将执行输出附加到文档中。

例如

.. runblock:: pycon

    >>> for i in range(5):
    ...    print i

生成

>>> for i in range(5):
...    print i
1
2
3
4
5

另一个例子

.. runblock:: console

    $ date

生成

$ date
Thu  4 Mar 2010 22:56:49 EST

目前 autorun 支持 pyconconsole 语言。还可以配置 autorun(从 conf.py)以运行其他语言。

安装

通过 pip 安装(推荐)

$ pip install sphinx-autorun

从源安装

$ git clone git@gitlab.com:hobarrera/sphinx-autorun.git
$ python setup.py install

要启用 autorun,请将 ‘sphinx_autorun’ 添加到 conf.py 中的扩展列表

extensions.append('sphinx_autorun')

文档在 doc/ 文件夹中。

关于这个分支

sphinx-contrib/autorun 已被弃用并损坏数月。由于它甚至无法工作,因此创建了此分支,作为其延续,主要是进行关键修复。

项目详情


下载文件

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

源分布

sphinx-autorun-ng-1.0.0.tar.gz (8.0 kB 查看哈希值)

上传时间

构建分布

sphinx_autorun_ng-1.0.0-py3-none-any.whl (7.9 kB 查看哈希值)

上传时间 Python 3

由以下机构支持