Function do_autodoc

tests/test_ext_autodoc/autodoc_util.py:39–83

(
    obj_type: _AutodocObjType,
    name: str,
    *,
    config: _AutodocConfig = _DEFAULT_CONFIG,
    current_document: _CurrentDocument | None = None,
    events: FakeEvents | None = None,
    expect_import_error: bool = False,
    options: dict[str, Any] | None = None,
    ref_context: Mapping[str, str | None] | None = None,
)

def do_autodoc(
    obj_type: _AutodocObjType,
    name: str,
    *,
    config: _AutodocConfig = _DEFAULT_CONFIG,
    current_document: _CurrentDocument | None = None,
    events: FakeEvents | None = None,
    expect_import_error: bool = False,
    options: dict[str, Any] | None = None,
    ref_context: Mapping[str, str | None] | None = None,
) -> list[str]:
    if current_document is None:
        current_document = _CurrentDocument(docname='index')
    if events is None:
        events = FakeEvents()
    if ref_context is None:
        ref_context = {}
    reread_always: set[str] = set()

    options = {} if options is None else options.copy()
    doc_options = _process_documenter_options(
        obj_type=obj_type,
        default_options=config.autodoc_default_options,
        options=options,
    )

    content = _auto_document_object(
        name=name,
        obj_type=obj_type,
        config=config,
        current_document=current_document,
        events=events,
        get_attr=safe_getattr,
        more_content=None,
        options=doc_options,
        record_dependencies=set(),
        ref_context=ref_context,
        reread_always=reread_always,
    )
    if expect_import_error:
        assert content is None
        return []

    assert content is not None
    return content.data