跳转到主要内容

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@github.com:hobarrera/sphinx-autorun.git
$ python setup.py install

要启用 autorun,请将“sphinx_autorun”添加到 conf.py 中的 extension 列表

extensions.append('sphinx_autorun')

文档位于 doc/ 文件夹中。

关于这个分支

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

项目详情


下载文件

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

源代码分发

sphinx-autorun-1.1.1.tar.gz (11.1 kB 查看哈希值)

上传于 源代码

构建分发版

sphinx_autorun-1.1.1-py3-none-any.whl (5.1 kB 查看哈希值)

上传于 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页