markdown_refdocs/types

Parsed

Parsed: TypedDict = TypedDict(
    'Parsed', {'name': str, 'source_code': str, 'hidden': bool}, total=False
)

Attributes

• name (str)
• source_code (str)
• hidden (bool)

ADMONITIONS

ADMONITIONS = [
    'warning',
    'note',
    'info',
    'bug',
    'tip',
    'question',
    'failure',
    'danger',
    'quote',
    'todo',
]

class ParsedParameter

inherits Parsed

Attributes

• default_value (str)
• type (str)
• description (str)

class ParsedReturn

inherits TypedDict

Attributes

• type (str)
• description (str)

class ParsedFunction

inherits Parsed

Result of the combination of parsing the source code and combining with the docstring of a function

Attributes

• parameters (List[ParsedParameter])
• returns (ParsedReturn)
• note (str)
• raises (List[str])
• examples (List[str])
• description (str)
• is_static (bool)
• is_method (bool)
• is_class_method (bool)
• is_getter (bool)

class ParsedDocstring

inherits TypedDict

Attributes

• description (str)
• note (str)
• examples (List[str])
• raises (List[str])
• returns (ParsedReturn)
• parameters (List[ParsedParameter])
• attributes (List[ParsedParameter])
• todo (List[str])

class ParsedVariable

inherits Parsed

Attributes

• type (str)
• description (str)
• value (str)
• attributes (List[Parsed])

class ParsedClass

inherits Parsed

Attributes

• functions (List[ParsedFunction])
• variables (List[ParsedVariable])
• description (str)
• inherits (List[str])
• attributes (List[Parsed])

class ParsedModule

inherits Parsed

Attributes

• classes (List[ParsedClass])
• functions (List[ParsedFunction])
• variables (List[ParsedVariable])
• description (str)