autodoc2.utils
¶
Module Contents¶
Classes¶
Functions¶
Data¶
API¶
- autodoc2.utils.PROPERTY_TYPE = None¶
- autodoc2.utils.ARGS_TYPE = None¶
- class autodoc2.utils.ItemData[source]¶
Bases:
typing.TypedDict
Initialization
- type: typing_extensions.Required[str] = None¶
- full_name: typing_extensions.Required[str] = None¶
- doc: typing_extensions.Required[str] = None¶
- range: tuple[int, int] = None¶
- file_path: None | str = None¶
- encoding: str = None¶
- all: None | list[str] = None¶
- imports: list[tuple[str, str | None]] = None¶
- value: None | str | Any = None¶
- annotation: None | str = None¶
- properties: list[autodoc2.utils.PROPERTY_TYPE] = None¶
- args: autodoc2.utils.ARGS_TYPE = None¶
- return_annotation: None | str = None¶
- bases: list[str] = None¶
- doc_inherited: str = None¶
- inherited: str = None¶
- class autodoc2.utils.WarningSubtypes(*args, **kwds)[source]¶
Bases:
enum.Enum
Initialization
- CONFIG_ERROR = 'config_error'¶
- GIT_CLONE_FAILED = 'git_clone'¶
- MISSING_MODULE = 'missing_module'¶
- DUPLICATE_ITEM = 'dup_item'¶
- RENDER_ERROR = 'render'¶
- ALL_MISSING = 'all_missing'¶
- ALL_RESOLUTION = 'all_resolve'¶
- NAME_NOT_FOUND = 'missing'¶