python - 使用 reST 嵌套 Sphinx 扩展指令

标签 python python-sphinx restructuredtext docutils

我想知道是否有办法嵌套 Sphinx 扩展指令。我有一些运行良好的自定义节点类型,但我希望生成的 HTML 具有更多灵 active 。

这是我要完成的示例:

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

.. myDirective:: name
    :opt1: val
    content

现在,我希望能够在输出中使用 jQuery 创建一个选项卡式界面。我有一个节点类型,可以创建实现此目的所需的原始 HTML/JavaScript。

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

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

    .. myDirective:: name2
        :op1: val1
        content

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

最佳答案

配置 block 扩展可能会帮助您: 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

关于python - 使用 reST 嵌套 Sphinx 扩展指令,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/16719826/

相关文章:

python - 带有 toctree 的自动摘要不为方法创建文档

python - 如何将weasyprint生成的PDF文件保存(存储)到指定目录?

python - 如何获取 PyQt4 应用程序中 QToolBar 图标的坐标?

python - Pygame 知道何时按下 shift+other 键

python - 如何使用类方法创建新实例

python - 如何将 Sphinx doctests 作为 setup.py 的一部分运行?

python-sphinx - Sphinx 无法导入模块依赖项

python-sphinx - 如何处理 ReST 中的两个破折号

markdown - 使用 MyST 在 Sphinx 中使用替换

python-sphinx - 如何使用 ReStructured Text 和 .. raw::html 更改字体?