docutils.parsers.rst.directives.body module

Directives for additional body elements.

See docutils.parsers.rst.directives for API details.

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

Bases: Directive

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 = {'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

Node class to be used (must be set in subclasses).

run()

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

Bases: BasePseudoSection

node_class

alias of topic

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

Bases: BasePseudoSection

node_class

alias of sidebar

required_arguments = 0

Number of required directive arguments.

optional_arguments = 1

Number of optional arguments after the required arguments.

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

Mapping of option names to validator functions.

run()

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

Bases: Directive

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

Mapping of option names to validator functions.

has_content = True

May the directive have content?

run()

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

Bases: Directive

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

Mapping of option names to validator functions.

has_content = True

May the directive have content?

run()

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

Bases: Directive

Parse and mark up content of a code block.

Configuration setting: syntax_highlight

Highlight Code content with Pygments? Possible values: (‘long’, ‘short’, ‘none’)

optional_arguments = 1

Number of optional arguments after the required arguments.

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

Mapping of option names to validator functions.

has_content = True

May the directive have content?

run()

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

Bases: Directive

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

Mapping of option names to validator functions.

has_content = True

May the directive have content?

run()

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

Bases: Directive

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 = {'class': <function class_option>, 'name': <function unchanged>}

Mapping of option names to validator functions.

run()

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

Bases: Directive

has_content = True

May the directive have content?

classes = []

run()

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

Bases: BlockQuote

classes = ['epigraph']

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

Bases: BlockQuote

classes = ['highlights']

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

Bases: BlockQuote

classes = ['pull-quote']

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

Bases: Directive

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

Mapping of option names to validator functions.

has_content = True

May the directive have content?

run()

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

Bases: Directive

optional_arguments = 1

Number of optional arguments after the required arguments.

final_argument_whitespace = True

May the final argument contain whitespace?

option_spec = {'name': <function unchanged>}

Mapping of option names to validator functions.

has_content = True

May the directive have content?

run()