5.5.2.12. sphinx.domains.python.PyDecoratorMethod

class sphinx.domains.python.PyDecoratorMethod(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Directive to mark methods meant to be used as decorators.

5.5.2.12.1. Methods

__init__(name, arguments, options, content, ...)
add_name(node) Append self.options[‘name’] to node[‘names’] if it exists.
add_target_and_index(name_cls, sig, signode)
after_content()
assert_has_content() Throw an ERROR-level DirectiveError if the directive doesn’t have contents.
before_content()
debug(message)
directive_error(level, message) Return a DirectiveError suitable for being thrown as an exception.
error(message)
get_index_text(modname, name_cls)
get_signature_prefix(sig)
get_signatures() Retrieve the signatures to document from the directive arguments.
handle_signature(sig, signode)
info(message)
needs_arglist()
run()
severe(message)
warning(message)