docutils.parsers.rst.directives.images.Image Class Reference

Inheritance diagram for docutils.parsers.rst.directives.images.Image:

Collaboration diagram for docutils.parsers.rst.directives.images.Image:

Public Member Functions
	align (argument)
	loading (argument)
	run (self)
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
	name
	align_v_values
	align_h_values
	block_text
	lineno
	options
Public Attributes inherited from docutils.parsers.rst.Directive
	name
	arguments
	options
	content
	lineno
	content_offset
	block_text
	state
	state_machine
	reporter

Static Public Attributes
tuple	align_h_values = ('left', 'center', 'right')
tuple	align_v_values = ('top', 'middle', 'bottom')
tuple	align_values = align_v_values + align_h_values
tuple	loading_values = ('embed', 'link', 'lazy')
int	required_arguments = 1
int	optional_arguments = 0
bool	final_argument_whitespace = 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

Member Function Documentation

run()

docutils.parsers.rst.directives.images.Image.run

(

self

)

Reimplemented from docutils.parsers.rst.Directive.

Member Data Documentation

option_spec

dict docutils.parsers.rst.directives.images.Image.option_spec

static

Initial value:

=  {'alt': directives.unchanged,
                   'height': directives.length_or_unitless,
                   'width': directives.length_or_percentage_or_unitless,
                   'scale': directives.percentage,
                   'align': align,
                   'target': directives.unchanged_required,
                   'loading': loading,
                   'class': directives.class_option,
                   'name': directives.unchanged}

---

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

• docs/help/help-venv/lib/python3.12/site-packages/docutils/parsers/rst/directives/images.py