layout.Doc

layout.Doc()

A python object to be documented.

Note that this class should not be used directly. Instead, use child classes like DocFunction.

Attributes

Name	Type	Description
name	str	The import path of the object (e.g. quartodoc.get_object).
obj	Union[dc.Object, dc.Alias]	The loaded python object.
anchor	str	An anchor named, used to locate this documentation on a quartodoc.layout.Page.

See Also

quartodoc.layout.DocModule, quartodoc.layout.DocClass, quartodoc.layout.DocFunction, quartodoc.layout.DocAttribute