matplotlib.sphinxext.figmpl_directive

Добавление директивы figure-mpl, являющейся адаптивной версией figure.

Эта реализация очень похожа на .. figure::, за исключением того, что она также позволяет передавать аргумент srcset= тегу изображения, тем самым позволяя использовать изображения с адаптивным разрешением.

Нет конкретной причины, по которой эта директива не может использоваться автономно, но она предназначена для использования с matplotlib.sphinxext.plot_directive.

Обратите внимание, что организация каталогов немного отличается от .. figure::. См. документацию FigureMpl ниже.

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

Реализует директиву, позволяющую использовать необязательное изображение hidpi.

Предназначена для использования с опцией конфигурации plot_srcset в файле conf.py и устанавливается в шаблоне 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:

.. 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" />

где подкаталог включен в имя изображения для уникальности.

final_argument_whitespace=False

Может ли конечный аргумент содержать пробелы?

has_content=False

Может ли директива содержать контент?

option_spec={'align': <function Image.align>, 'alt': <function unchanged>, 'caption': <function unchanged>, 'class': <function class_option>, 'height': <function length_or_unitless>, 'scale': <function nonnegative_int>, 'srcset': <function unchanged>, 'width': <function length_or_percentage_or_unitless>}

Сопоставление имен опций с функциями-валидаторами.

optional_arguments=2

Количество необязательных аргументов после обязательных.

required_arguments=1

Количество обязательных аргументов директивы.

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