docutils.parsers.rst.directives.admonitions module

Admonition directives.

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

Bases: Directive

final_argument_whitespace = True

May the final argument contain whitespace?

option_spec = {'class': <function class_option>, 'name': <function unchanged>}

Mapping of option names to validator functions.

has_content = True

May the directive have content?

node_class = None

Subclasses must set this to the appropriate admonition node class.

run()

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

Bases: BaseAdmonition

required_arguments = 1

Number of required directive arguments.

node_class

alias of admonition

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

Bases: BaseAdmonition

node_class

alias of attention

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

Bases: BaseAdmonition

node_class

alias of caution

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

Bases: BaseAdmonition

node_class

alias of danger

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

Bases: BaseAdmonition

node_class

alias of error

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

Bases: BaseAdmonition

node_class

alias of hint

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

Bases: BaseAdmonition

node_class

alias of important

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

Bases: BaseAdmonition

node_class

alias of note

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

Bases: BaseAdmonition

node_class

alias of tip

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

Bases: BaseAdmonition

node_class

alias of warning