class documentation

class PyClasslike(PyObject):

View In Hierarchy

Description of a class-like object (classes, interfaces, exceptions).
Method get​_index​_text Return the text for the index entry of the object.
Method get​_signature​_prefix May return a prefix to put before the object name in the signature.
Class Variable allow​_nesting Undocumented
Class Variable option​_spec Undocumented

Inherited from PyObject:

Method add​_target​_and​_index Undocumented
Method after​_content Handle object de-nesting after content
Method before​_content Handle object nesting before content
Method handle​_signature Transform a Python signature into RST nodes.
Method needs​_arglist May return true if an empty argument list is to be generated even if the document contains none.
Class Variable doc​_field​_types Undocumented
def get_index_text(self, modname, name_cls):
Return the text for the index entry of the object.
Parameters
modname:strUndocumented
name​_cls:Tuple[str, str]Undocumented
Returns
strUndocumented
def get_signature_prefix(self, sig):
May return a prefix to put before the object name in the signature.
Parameters
sig:strUndocumented
Returns
List[nodes.Node]Undocumented
allow_nesting: bool =
option_spec: OptionSpec =