Python matplotlib FigureMpl用法及代码示例

本文简要介绍 python 语言中 matplotlib.sphinxext.figmpl_directive.FigureMpl 的用法。

用法

class matplotlib.sphinxext.figmpl_directive.FigureMpl(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

实现一个指令以允许可选的 hidpi 图像。

旨在与 conf.py 中的 plot_srcset 配置选项一起使用，并在 plot_directive.py 的模板中设置

例如：

.. figure-mpl:: plot_directive/some_plots-1.png
    :alt: bar
    :srcset: plot_directive/some_plots-1.png,
             plot_directive/some_plots-1.2x.png 2.00x
    :class: plot-directive

生成的 html(位于 some_plots.html )为：

<img src="sphx_glr_bar_001_hidpi.png"
    srcset="_images/some_plot-1.png,
            _images/some_plots-1.2x.png 2.00x",
    alt="bar"
    class="plot_directive" />

请注意，子目录的处理与 sphinx 图指令使用的不同：

.. figure-mpl:: plot_directive/nestedpage/index-1.png
    :alt: bar
    :srcset: plot_directive/nestedpage/index-1.png
             plot_directive/nestedpage/index-1.2x.png 2.00x
    :class: plot_directive

生成的 html(位于 nestedpage/index.html )：

<img src="../_images/nestedpage-index-1.png"
    srcset="../_images/nestedpage-index-1.png,
            ../_images/_images/nestedpage-index-1.2x.png 2.00x",
    alt="bar"
    class="sphx-glr-single-img" />

其中子目录包含在图像名称中以确保唯一性。