sphinx.ext.autodoc.ObjectMember

class documentation

class ObjectMember(tuple): (source)

A member of object. This is used for the result of `Documenter.get_module_members()` to represent each member of the object. .. Note:: An instance of this class behaves as a tuple of (name, object) for compatibility to old Sphinx. The behavior will be dropped in the future. Therefore extensions should not use the tuple interface.

Method	`__init__`	Undocumented
Method	`__new__`	Undocumented
Instance Variable	`__name__`	Undocumented
Instance Variable	`class_`	Undocumented
Instance Variable	`docstring`	Undocumented
Instance Variable	`object`	Undocumented
Instance Variable	`skipped`	Undocumented

def __init__(self, name, obj, docstring=None, class_=None, skipped=False): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented
obj:`Any`	Undocumented
docstring:`str\|None`	Undocumented
class_:`Any`	Undocumented
skipped:`bool`	Undocumented

def __new__(cls, name, obj, **kwargs): (source) ¶

Undocumented

Parameters
cls	Undocumented
name:`str`	Undocumented
obj:`Any`	Undocumented
**kwargs:`Any`	Undocumented
Returns
`Any`	Undocumented

__name__ = (source) ¶

Undocumented

class_ = (source) ¶

Undocumented

docstring = (source) ¶

Undocumented

object = (source) ¶

Undocumented

skipped = (source) ¶

Undocumented