matplotlib.sphinxext.figmpl_directive#

Fügt eine figure-mpl Direktive hinzu, die eine responsive Version von figure ist.

Diese Implementierung ist der Direktive .. figure:: sehr ähnlich, mit dem Unterschied, dass sie auch ein srcset= Argument für das Bild-Tag erlaubt, wodurch responsive Auflösungsbilder ermöglicht werden.

Es gibt keinen besonderen Grund, warum dies nicht eigenständig verwendet werden könnte, aber es ist für die Verwendung mit matplotlib.sphinxext.plot_directive gedacht.

Beachten Sie, dass die Verzeichnisorganisation etwas anders ist als bei der Direktive .. figure::. Siehe die FigureMpl Dokumentation unten.

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

Implementiert eine Direktive, um ein optionales HiDPI-Bild zu ermöglichen.

Gedacht zur Verwendung mit der Konfigurationsoption plot_srcset in conf.py und wird im TEMPLATE von plot_directive.py gesetzt.

z. B.

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

Das resultierende HTML (unter some_plots.html) ist

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

Beachten Sie, dass die Handhabung von Unterverzeichnissen anders ist als die des Sphinx-Figure-Direktivs.

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

Das resultierende HTML (unter 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" />

wobei das Unterverzeichnis zur Eindeutigkeit in den Bildnamen aufgenommen wird.

final_argument_whitespace = False#

Darf das letzte Argument Leerzeichen enthalten?

has_content = False#

Darf die Direktive Inhalt haben?

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>}#

Zuordnung von Optionsnamen zu Validatorfunktionen.

optional_arguments = 2#

Anzahl der optionalen Argumente nach den erforderlichen Argumenten.

required_arguments = 1#

Anzahl der erforderlichen Direktivenargumente.

class matplotlib.sphinxext.figmpl_directive.figmplnode(rawsource='', *children, **attributes)[Quelle]#
Auf dieser Seite