__init__(name, arguments, options, content, ...) |
|
add_name(node) |
Append self.options[‘name’] to node[‘names’] if it exists. |
add_target_and_index(name, sig, signode) |
Add cross-reference IDs and entries to self.indexnode, if applicable. |
after_content() |
Called after parsing content. |
assert_has_content() |
Throw an ERROR-level DirectiveError if the directive doesn’t have contents. |
before_content() |
Called before parsing content. |
debug(message) |
|
directive_error(level, message) |
Return a DirectiveError suitable for being thrown as an exception. |
error(message) |
|
get_signatures() |
Retrieve the signatures to document from the directive arguments. |
handle_signature(sig, signode) |
Parse the signature sig into individual nodes and append them to signode. |
info(message) |
|
run() |
Main directive entry function, called by docutils upon encountering the directive. |
severe(message) |
|
warning(message) |
|