autodoc.models.python

Parameter name

Type annotation as string (e.g., "str | None")

Default value as string (e.g., "None", "'default'")

Parameter kind (positional, keyword, var_positional, var_keyword)

Description from docstring

Exception type name

Description of when raised

One-line summary

Full description (may include summary)

Parameter documentation

Return value description

Exception documentation

Code examples

Path to source file

Whether this is a package (init.py)

Whether module defines all

Contents of all if present

Base class names

Decorator names

Whether class inherits from Exception/BaseException

Whether class has @dataclass decorator

Whether class inherits from ABC

Parsed docstring

Full signature string (e.g., "def build(self, force: bool = False) -> None")

Parameter information

Return type annotation as string

Whether function is async

Whether function has @classmethod decorator

Whether function has @staticmethod decorator

Whether function has @property decorator

Whether function uses yield

Decorator names

Parsed docstring

Type annotation as string

Whether this is a class variable

Default value as string

Qualified name of the aliased entity

Type of alias (assignment or import)