sphinxcontrib-jsdemo 0.1.4

概述

sphinxcontrib-jsdemo 是一个用于将HTML/Javascript演示代码片段嵌入到 Sphinx 文档的扩展。

您可以在 http://htsql.org/htraf/index.html 上看到此扩展的实际应用。更多示例，请参阅源分布中的 demo 目录。

此软件由Kirill Simonov (Prometheus Research, LLC) 编写，并使用BSD许可证发布。

使用方法

要启用此扩展，请将以下行添加到 conf.py

extensions.append('sphinxcontrib.jsdemo')

现在，您可以使用 demo 指令将HTML/Javascript代码片段包含到Sphinx文档中。例如

.. demo::

   <button>Click me!</button>

指令将其内容渲染两次：作为原始HTML块（demo）和作为字面块（source）。点击 演示 和 源 标题可以切换块的可见性。

选项 layout 允许您控制块之间的相对顺序。例如，以下指令在演示块的内容最初隐藏的情况下，在演示块之前渲染源块

.. demo::
   :layout: +source, -demo

   <button>Click me, too!</button>

参考