matplotlib.sphinxext.figmpl_directive#

Add afigure-mpl directive that is a responsive version offigure.

This implementation is very similar to..figure::, except it also allows asrcset= argument to be passed to the image tag, hence allowing responsiveresolution images.

There is no particular reason this could not be used standalone, but is meantto be used withmatplotlib.sphinxext.plot_directive.

Note that the directory organization is a bit different than..figure::.See theFigureMpl documentation below.

classmatplotlib.sphinxext.figmpl_directive.FigureMpl(name,arguments,options,content,lineno,content_offset,block_text,state,state_machine)[source]#

Implements a directive to allow an optional hidpi image.

Meant to be used with theplot_srcset configuration option in conf.py,and gets set in the TEMPLATE of plot_directive.py

e.g.:

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

The resulting html (atsome_plots.html) is:

<imgsrc="sphx_glr_bar_001_hidpi.png"srcset="_images/some_plot-1.png,_images/some_plots-1.2x.png2.00x",alt="bar"class="plot_directive"/>

Note that the handling of subdirectories is different than that used by the sphinxfigure directive:

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

The resulting html (atnestedpage/index.html):

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

where the subdirectory is included in the image name for uniqueness.

final_argument_whitespace=False#

May the final argument contain whitespace?

has_content=False#

May the directive have content?

option_spec={'align':<functionImage.align>,'alt':<functionunchanged>,'caption':<functionunchanged>,'class':<functionclass_option>,'height':<functionlength_or_unitless>,'scale':<functionnonnegative_int>,'srcset':<functionunchanged>,'width':<functionlength_or_percentage_or_unitless>}#

Mapping of option names to validator functions.

optional_arguments=2#

Number of optional arguments after the required arguments.

required_arguments=1#

Number of required directive arguments.

classmatplotlib.sphinxext.figmpl_directive.figmplnode(rawsource='',*children,**attributes)[source]#