sphinx_gallery.scrapers#
用于嵌入图像的抓取器。
收集由代码块生成的图像。
我们原生支持的唯一抓取器是 Matplotlib，其他抓取器应该位于支持它们的模块中（例如，PyVista、Plotly）。抓取的图像被注入为 rst image-sg 指令，到为每个示例脚本生成的 .rst 文件中。
函数#
- sphinx_gallery.scrapers.clean_modules(gallery_conf, fname, when)[source]#
移除、卸载或重置模块。
脚本执行后，它可能会加载各种设置，而你不希望这些设置影响画廊中的其他示例。
- sphinx_gallery.scrapers.figure_rst(figure_list, sources_dir, fig_titles='', srcsetpaths=None)[source]#
为图像文件名列表生成 reST。
根据我们是否有多个图形，我们将使用单个 rst 调用“image”或水平列表。
- 参数：:
figure_list (list) – 图像的绝对路径的字符串列表。
sources_dir (str) – Sphinx 文档源的绝对路径
fig_titles (str) – 图像标题，如果未找到标题则为空字符串。目前仅支持 matplotlib 图像，默认值为 ‘’。
srcsetpaths (list or None) – 包含绝对路径的字典列表。如果为空，则 srcset 字段将使用图像路径填充。（参见
image_srcset配置选项）。否则，每个字典都采用以下形式：{0: /images/image.png, 2.0: /images/image_2_00x.png}，其中键是乘法因子，内容是上面创建的图像的路径。
- 返回值：:
images_rst (str) – 用于将图像嵌入文档中的 rst 代码
rst 代码将具有一个自定义的
image-sg指令，该指令允许服务多分辨率图像，例如
`` (srcset: /plot_types/imgs/img_001.png,) – /plot_types/imgs/img_2_00x.png 2.00x``
- sphinx_gallery.scrapers.matplotlib_scraper(block, block_vars, gallery_conf, **kwargs)[source]#
抓取 Matplotlib 图像。
- 参数：:
block (sphinx_gallery.py_source_parser.Block) – 要执行的代码块。格式（标签、内容、行号）。
block_vars (dict) – 块变量字典。
gallery_conf (dict) – 包含 Sphinx-Gallery 的配置
**kwargs (dict) –
要传递给
savefig()的额外关键字参数，例如format='svg'。特别是，format关键字参数用于设置输出文件的扩展名（目前仅支持 ‘png’、‘jpg’、‘svg’、‘gif’ 和 ‘webp’）。这不是在内部使用，而是旨在在覆盖抓取器时使用。
- 返回值：:
rst – 将被渲染为包含图像的 HTML 的 reStructuredText。这通常由
figure_rst()生成。- 返回类型：: