Inheritance diagram for myst_parser.sphinx_ext.directives.FigureMarkdown:

Collaboration diagram for myst_parser.sphinx_ext.directives.FigureMarkdown:

Public Member Functions
list[nodes.Node]	run (self)

	figure_error (self, message)

Public Member Functions inherited from sphinx.util.docutils.SphinxDirective
BuildEnvironment	env (self)

Config	config (self)

tuple[str, int]	get_source_info (self)

None	set_source_info (self, Node node)

str	get_location (self)

list[Node]	parse_content_to_nodes (self, bool allow_section_headings=False)

list[Node]	parse_text_to_nodes (self, str text='', *int offset=-1, bool allow_section_headings=False)

tuple[list[Node], list[system_message]]	parse_inline (self, str text, *int lineno=-1)

Public Member Functions inherited from docutils.parsers.rst.Directive
	__init__ (self, name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

	directive_error (self, level, message)

	debug (self, message)

	info (self, message)

	warning (self, message)

	error (self, message)

	severe (self, message)

	assert_has_content (self)

	add_name (self, node)

Public Attributes
	state

	content

	content_offset

	block_text

Public Attributes inherited from sphinx.util.docutils.SphinxDirective
	lineno

	state

	content

Public Attributes inherited from docutils.parsers.rst.Directive
	name

	arguments

	options

	content

	lineno

	content_offset

	block_text

	state

	state_machine

	reporter

Static Public Attributes
int	required_arguments = 0

int	optional_arguments = 1

bool	final_argument_whitespace = True

bool	has_content = True

dict	option_spec

Static Public Attributes inherited from docutils.parsers.rst.Directive
int	required_arguments = 0

int	optional_arguments = 0

bool	final_argument_whitespace = False

	option_spec = None

bool	has_content = False

Detailed Description

Directive for creating a figure with Markdown compatible syntax.

Example::

    :::{figure-md} target
    <img src="img/fun-fish.png" alt="fishy" class="bg-primary mb-1" width="200px">

    This is a caption in **Markdown**
    :::

Member Function Documentation

◆ figure_error()

myst_parser.sphinx_ext.directives.FigureMarkdown.figure_error	(	self,
		message
	)

A warning for reporting an invalid figure.

◆ run()

list[nodes.Node] myst_parser.sphinx_ext.directives.FigureMarkdown.run ( self )

Reimplemented from docutils.parsers.rst.Directive.

Member Data Documentation

◆ option_spec

dict myst_parser.sphinx_ext.directives.FigureMarkdown.option_spec

static

Initial value:

=  {
        "width": figwidth_value,
        "class": directives.class_option,
        "align": align,
        "name": directives.unchanged,
    }

The documentation for this class was generated from the following file:

docs/help/help-venv/lib/python3.12/site-packages/myst_parser/sphinx_ext/directives.py

Public Member Functions