preview

preview(ast, max_depth=999, compact=False, as_string=False)

Print a friendly representation of a griffe object (e.g. function, docstring)

Examples

>>> from quartodoc import get_object
>>> obj = get_object("quartodoc", "get_object")

>>> preview(obj.docstring.parsed)
 ...

>>> preview(obj)
 ...