docutils.parsers.rst.directives.admonitions.BaseAdmonition

class documentation

class BaseAdmonition(Directive): (source)

Known subclasses: docutils.parsers.rst.directives.admonitions.Admonition, docutils.parsers.rst.directives.admonitions.Attention, docutils.parsers.rst.directives.admonitions.Caution, docutils.parsers.rst.directives.admonitions.Danger, docutils.parsers.rst.directives.admonitions.Error, docutils.parsers.rst.directives.admonitions.Hint, docutils.parsers.rst.directives.admonitions.Important, docutils.parsers.rst.directives.admonitions.Note, docutils.parsers.rst.directives.admonitions.Tip, docutils.parsers.rst.directives.admonitions.Warning

Constructor: BaseAdmonition(name, arguments, options, content, ...)

View In Hierarchy

Undocumented

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 node_class Subclasses must set this to the appropriate admonition node class.
Class Variable option_spec Mapping of option names to validator functions.

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 optional_arguments Number of optional arguments after the required arguments.
Class Variable required_arguments Number of required directive arguments.
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): (source)
overrides docutils.parsers.rst.Directive.run

Undocumented

final_argument_whitespace: bool = (source)
overrides docutils.parsers.rst.Directive.final_argument_whitespace

May the final argument contain whitespace?

has_content: bool = (source)
overrides docutils.parsers.rst.Directive.has_content

May the directive have content?

node_class = (source)

Subclasses must set this to the appropriate admonition node class.

option_spec = (source)
overrides docutils.parsers.rst.Directive.option_spec

Mapping of option names to validator functions.