sphinx.domains.ObjType

class documentation

class ObjType:

View In Hierarchy

An ObjType is the description for a type of object that a domain can document. In the object_types attribute of Domain subclasses, object type names are mapped to instances of this class.

Constructor arguments:

  • lname: localized name of the type (do not include domain name)
  • roles: all the roles that can refer to an object of this type
  • attrs: object attributes -- currently only "searchprio" is known, which defines the object's priority in the full-text search index, see Domain.get_objects().
Method __init__ Undocumented
Class Variable known​_attrs Undocumented
Instance Variable attrs Undocumented
Instance Variable lname Undocumented
Instance Variable roles Undocumented
def __init__(self, lname, *roles, **attrs):

Undocumented

Parameters
lname:strUndocumented
*roles:AnyUndocumented
**attrs:AnyUndocumented
known_attrs: dict[str, int] =

Undocumented

attrs: Dict =

Undocumented

lname =

Undocumented

roles: Tuple =

Undocumented