8.3.2.2.3. DispatcherSphinxDirective

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

Methods

__delattr__	Implement delattr(self, name).
__dir__	Default dir() implementation.
__eq__	Return self==value.
__format__	Default object formatter.
__ge__	Return self>=value.
__getattribute__	Return getattr(self, name).
__getstate__	Helper for pickle.
__gt__	Return self>value.
__hash__	Return hash(self).
__init__
__init_subclass__	This method is called when a class is subclassed.
__le__	Return self<=value.
__lt__	Return self<value.
__ne__	Return self!=value.
__new__
__reduce__	Helper for pickle.
__reduce_ex__	Helper for pickle.
__repr__	Return repr(self).
__setattr__	Implement setattr(self, name, value).
__sizeof__	Size of object in memory, in bytes.
__str__	Return str(self).
__subclasshook__	Abstract classes can override this to customize issubclass().
add_name	Append self.options['name'] to node['names'] if it exists.
assert_has_content	Throw an ERROR-level DirectiveError if the directive doesn't have contents.
debug
directive_error	Return a DirectiveError suitable for being thrown as an exception.
error
get_location	Get current location info for logging.
get_source_info	Get source and line number.
info
parse_content_to_nodes	Parse the directive's content into nodes.
parse_inline	Parse text as inline elements.
parse_text_to_nodes	Parse text into nodes.
run
set_source_info	Set source and line number to the node.
severe
warning

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

Attributes

__annotations__
__dict__
__doc__
__module__
__weakref__	list of weak references to the object
config	Reference to the Config object.
env	Reference to the BuildEnvironment object.
final_argument_whitespace	May the final argument contain whitespace?
has_content	May the directive have content?
img_opt
option_spec	Mapping of option names to validator functions.
optional_arguments	Number of optional arguments after the required arguments.
required_arguments	Number of required directive arguments.

required_arguments = 1

Number of required directive arguments.

img_opt = {'height': <function length_or_unitless>, 'width': <function length_or_percentage_or_unitless>}

option_spec: ClassVar[OptionSpec] = {'align': <function align_spec>, 'alt': <function unchanged>, 'caption': <function unchanged>, 'class': <function class_option>, 'graphviz_dot': <function unchanged>, 'height': <function length_or_unitless>, 'index': <function bool_option>, 'layout': <function unchanged>, 'name': <function unchanged>, 'viz': <function bool_option>, 'width': <function length_or_percentage_or_unitless>}

Mapping of option names to validator functions.

run()

__annotations__ = {'option_spec': 'ClassVar[OptionSpec]'}

__doc__ = None

__module__ = 'schedula.ext.dispatcher.graphviz'