狮身人面像延伸自动运行
sphinx-autorun-ng的Python项目详细描述
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
当前自动运行支持pycon和console语言。它也是 可以配置autorun(从conf.py)来运行其他语言。
安装
通过PIP安装(推荐):
$ pip install sphinx-autorun
从源安装:
$ git clone git@gitlab.com:hobarrera/sphinx-autorun.git $ python setup.py install
若要启用自动运行,请将“sphinx_autorun”添加到中的extension列表 conf.py:
extensions.append('sphinx_autorun')
文档在doc/文件夹中。
关于这个叉子
狮身人面像发明者/自动运行被遗弃和破坏了几个月。从那以后 根本不起作用,这个叉子是作为它的延续而创造的 关键修复。