sphinx_gallery.directives#

自定义 Sphinx 指令。

函数#

sphinx_gallery.directives.depart_imgsg_html(self, node)[source]#: HTML 离开节点访问器函数。

sphinx_gallery.directives.depart_imgsg_latex(self, node)[source]#: LaTeX 离开节点访问器函数。

sphinx_gallery.directives.imagesg_addnode(app)[source]#: 使用 HTML 和 LaTeX 的访问器函数将 imgsgnode 添加到 Sphinx 应用程序中。

sphinx_gallery.directives.visit_imgsg_html(self, node)[source]#

根据 'srcset' 配置处理 HTML 图片标签。

如果 'srcset' 不为 None，复制图片，使用 'srcset' 生成图片 html 标签，并添加到 HTML body 中。如果 'srcset' 为 None，则在 node 上运行 visit_image。

sphinx_gallery.directives.visit_imgsg_latex(self, node)[source]#: 复制图片，将 node[uri] 设置为最高分辨率图片，并调用 visit_image。

类#

class sphinx_gallery.directives.ImageSg(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#

实现一个指令，允许使用可选的 hidpi 图片。

旨在与 image_srcset 配置选项一起使用。

例如：

.. image-sg:: /plot_types/basic/images/sphx_glr_bar_001.png
    :alt: bar
    :srcset: /plot_types/basic/images/sphx_glr_bar_001.png,
             /plot_types/basic/images/sphx_glr_bar_001_2_00x.png 2.00x
    :class: sphx-glr-single-img

生成的 html 为

<img src="sphx_glr_bar_001_hidpi.png"
    srcset="_images/sphx_glr_bar_001.png,
            _images/sphx_glr_bar_001_2_00x.png 2x",
    alt="bar"
    class="sphx-glr-single-img" />

final_argument_whitespace = False#: 最后一个参数是否可以包含空格？

has_content = False#: 指令是否可以包含内容？

option_spec = {'alt': <function unchanged>, 'class': <function class_option>, 'srcset': <function unchanged>}#: 选项名称到验证器函数的映射。

optional_arguments = 3#: 必需参数之后的可选参数数量。

required_arguments = 1#: 必需指令参数的数量。

run()[source]#: 更新节点内容。

class sphinx_gallery.directives.MiniGallery(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#

自定义指令，用于插入一个小型画廊。

必需的参数是以下一个或多个：

对象的完全限定名称
示例 Python 文件的路径式字符串
示例 Python 文件的 glob 风格路径式字符串

参数的字符串列表由空格分隔。

小型画廊将是画廊示例的子集，这些示例使用来自该特定命名空间的该对象。

选项

add-heading 将标题添加到小型画廊。如果提供了参数，则使用该参数作为标题文本。否则，使用默认文本。
heading-level 指定标题的级别，用单个字符表示。如果省略，则默认标题级别为 ‘^’。

final_argument_whitespace = True#: 最后一个参数是否可以包含空格？

has_content = True#: 指令是否可以包含内容？

option_spec = {'add-heading': <function unchanged>, 'heading-level': <function single_char_or_unicode>}#: 选项名称到验证器函数的映射。

optional_arguments = 1#: 必需参数之后的可选参数数量。

required_arguments = 0#: 必需指令参数的数量。

run()[source]#: 从反向引用和示例文件生成小型画廊。

class sphinx_gallery.directives.imgsgnode(rawsource='', *children, **attributes)[source]#: Sphinx Gallery 图片节点类。