docutils.parsers.rst.directives.misc.Class

class documentation

class Class(Directive):

View In Hierarchy

Set a "class" attribute on the directive content or the next element. When applied to the next element, a "pending" element is inserted, and a transform does the work later.
Method run Undocumented
Class Variable final​_argument​_whitespace May the final argument contain whitespace?
Class Variable has​_content May the directive have content?
Class Variable optional​_arguments Number of optional arguments after the required arguments.
Class Variable required​_arguments Number of required directive arguments.

Inherited from Directive:

Method __init__ Undocumented
Method add​_name Append self.options['name'] to node['names'] if it exists.
Method assert​_has​_content Throw an ERROR-level DirectiveError if the directive doesn't have contents.
Method debug Undocumented
Method directive​_error Return a DirectiveError suitable for being thrown as an exception.
Method error Undocumented
Method info Undocumented
Method severe Undocumented
Method warning Undocumented
Class Variable option​_spec Mapping of option names to validator functions.
Instance Variable arguments Undocumented
Instance Variable block​_text Undocumented
Instance Variable content Undocumented
Instance Variable content​_offset Undocumented
Instance Variable lineno Undocumented
Instance Variable name Undocumented
Instance Variable options Undocumented
Instance Variable state Undocumented
Instance Variable state​_machine Undocumented
def run(self):
overrides docutils.parsers.rst.Directive.run

Undocumented

final_argument_whitespace: bool =
overrides docutils.parsers.rst.Directive.final_argument_whitespace
May the final argument contain whitespace?
has_content: bool =
overrides docutils.parsers.rst.Directive.has_content
May the directive have content?
optional_arguments: int =
overrides docutils.parsers.rst.Directive.optional_arguments
Number of optional arguments after the required arguments.
required_arguments: int =
overrides docutils.parsers.rst.Directive.required_arguments
Number of required directive arguments.