class Hint(BaseAdmonition):
Undocumented
Inherited from BaseAdmonition
:
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
(via BaseAdmonition
):
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 |