Typing Information

Type Aliases

DisplayNameFormat

Literal[
    "full", "name", "short", "relative", "canonical"
]

DocObjectKind

Literal[
    "module",
    "class",
    "method",
    "function",
    "attribute",
    "alias",
    "type",
    "typevar",
]

DocstringDefinitionType

(
    gf.DocstringParameter
    | gf.DocstringAttribute
    | gf.DocstringReturn
    | gf.DocstringYield
    | gf.DocstringReceive
    | gf.DocstringRaise
    | gf.DocstringWarn
)

Documentable

(
    # _Docable, Doc
    DocClass
    | DocFunction
    | DocAttribute
    | DocModule
    # _Docable
    | Link
    # Structual
    | Page
    | Section
    | Layout
)

RenderObjType

(
    RenderDoc
    | RenderDocClass
    | RenderDocFunction
    | RenderDocAttribute
    | RenderDocModule
    | RenderLayout
    | RenderPage
    | RenderSection
)

Annotation

str | gf.Expr

DocType

DocClass | DocFunction | DocAttribute | DocModule

DocMemberType

MemberPage | Doc | Link

SummaryItem

tuple[str, str]