使用reST嵌套Sphinx扩展指令

时间:2013-05-23 17:02:46

标签: python python-sphinx restructuredtext docutils

我正在试图弄清楚是否有办法嵌套Sphinx扩展指令。我有一些工作得很好的自定义节点类型,但我想在我生成的HTML中有一点灵活性。

这是我想要完成的一个例子:

假设我有一个指令创建一个触发一些JavaScript的文本框和按钮。这很好 - 我可以把它放在我的reST文件中:

.. myDirective:: name
    :opt1: val
    content

现在,我希望能够在输出中使用jQuery创建一个标签式界面。我有一个节点类型,可以创建发生这种情况所需的原始HTML / JavaScript。

我希望能够为tab节点提供1个或多个myDirective实例(或其他指令),并让它将每个实例放入另一个选项卡。像这样:

..tabbedInterface:: 
    .. myDirective:: name1
        :op1: val1
        content

    .. myDirective:: name2
        :op1: val1
        content

显然这是一个非常具体的案例,但这通常是我想要完成的 - 嵌套指令。

1 个答案:

答案 0 :(得分:4)

配置块扩展可能对您有所帮助: https://github.com/fabpot/sphinx-php/blob/master/sensio/sphinx/configurationblock.py

来自:http://symfony.com/doc/2.0/contributing/documentation/format.html#configuration-blocks

.. configuration-block::

  .. code-block:: yaml

    # Configuration in YAML

  .. code-block:: xml

    <!-- Configuration in XML //-->

  .. code-block:: php

    // Configuration in PHP