protected_fields: set
default_fields: dict

__init__(self, obj, *, spec=None, tree=None, name=None, parent=None, walker: 'ObjectWalker' = None, extra_fields=None, **kwargs): 

__getitem__(self, item): 

resolve_key(self, key, default=None): 

@property
name(self): 

Returns the name (not full identifier) of the object being documented

• :returns: _

get_name(self): 

Returns the name the object will have in its documentation page

• :returns: _

get_identifier(o): 

@property
identifier(self): 

@property
parent(self): 

Returns the parent object for docs purposes

• :returns: _

resolve_parent(self, check_tree=True): 

Resolves the “parent” of obj. By default, just the module in which it is contained. Allows for easy skipping of pieces of the object tree, though, since a parent can be directly added to the set of written object which is distinct from the module it would usually resolve to. Also can be subclassed to provide more fine grained behavior.

• obj: Any

• :returns: _

resolve_relative_obj(self, spec: str): 

@property
children(self): 

Returns the child objects for docs purposes

• :returns: _

resolve_children(self, check_tree=True): 

Resolves the “children” of obj. First tries to use any info supplied by the docs tree or a passed object spec, then that failing looks for an __all__ attribute

• obj: Any

• :returns: _

@property
tree_spec(self): 

Provides info that gets added to the written dict and which allows for a doc tree to be built out.

• :returns: _

handle(self): 

stop_traversal(self):