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 支持 pycon 和 console 语言。还可以配置 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.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | ff132a5903b172fe03663d9ad2dd5753b751beed78be77c6072cd7fddd50a19b |
|
MD5 | e2a26857dc9f2c30a27c09424bf41567 |
|
BLAKE2b-256 | 3dc0cff7805efb02d80643e0f27846e1d12905fb3590560d98d3dbfbb782fbdd |
关闭
sphinx_autorun_ng-1.0.0-py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 33a0217aa4b783f21c283b4d99f0b0d978ae16f1c6286fb8ced82f22fe91a183 |
|
MD5 | f9dacbbbee14d2c137a95e0edcdda91c |
|
BLAKE2b-256 | 68a05bfa1eab69424d474ae2994247b4723c3fd99c8949e49f9b2fa8a9d7de0d |