layout.Item

layout.Item()

Information about a documented object, including a URI to its location.

Item is used to creative relative links within a documented API. All of the items for an API are saved as an inventory file (usually named objects.json), so documentation sites can link across each other.

Attributes

name : str

The name of the object.

obj : Union[dc.Object, dc.Alias]

A representation of the object (eg its parameters and parsed docstring)

uri : Optional[str]

A relative URI link to the object from the root of the documentation site.

dispname : Optional[str]

Default display name, if none is specified in the interlink. If None, the default is to dipslay the name attribute.