docutils.parsers.rst.directives.images module

Directives for figures and simple images.

class Image(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: Directive

align_h_values = ('left', 'center', 'right')

align_v_values = ('top', 'middle', 'bottom')

align_values = ('top', 'middle', 'bottom', 'left', 'center', 'right')

align()

required_arguments = 1

Number of required directive arguments.

optional_arguments = 0

Number of optional arguments after the required arguments.

final_argument_whitespace = True

May the final argument contain whitespace?

option_spec = {'align': <function Image.align>, 'alt': <function unchanged>, 'class': <function class_option>, 'height': <function length_or_unitless>, 'name': <function unchanged>, 'scale': <function percentage>, 'target': <function unchanged_required>, 'width': <function length_or_percentage_or_unitless>}

Mapping of option names to validator functions.

run()

class Figure(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: Image

align()

figwidth_value()

option_spec = {'align': <function Figure.align>, 'alt': <function unchanged>, 'class': <function class_option>, 'figclass': <function class_option>, 'figwidth': <function Figure.figwidth_value>, 'height': <function length_or_unitless>, 'name': <function unchanged>, 'scale': <function percentage>, 'target': <function unchanged_required>, 'width': <function length_or_percentage_or_unitless>}

Mapping of option names to validator functions.

has_content = True

May the directive have content?

run()