autodoc2.config
¶
Module Contents¶
Classes¶
Functions¶
Data¶
API¶
- autodoc2.config.CONFIG_PREFIX = 'autodoc2_'¶
- class autodoc2.config.PackageConfig[source]¶
- path: str = None¶
- from_git_clone: tuple[str, str] | None = None¶
- module: str | None = None¶
- exclude_dirs: list[str] = None¶
- exclude_files: list[str] = None¶
- auto_mode: bool = None¶
- autodoc2.config._coerce_packages(name: str, item: Any) list[autodoc2.config.PackageConfig] [source]¶
- autodoc2.config._validate_list_tuple_regex_str(name: str, item: Any) list[tuple[Pattern[str], str]] [source]¶
- autodoc2.config._load_renderer(name: str, item: Any) type[autodoc2.render.base.RendererBase] [source]¶
- autodoc2.config._load_regex_renderers(name: str, item: Any) list[tuple[Pattern[str], type[autodoc2.render.base.RendererBase]]] [source]¶
- class autodoc2.config.Config[source]¶
- packages: list[autodoc2.config.PackageConfig] = None¶
- output_dir: str = None¶
- render_plugin: type[autodoc2.render.base.RendererBase] = None¶
- render_plugin_regexes: list[tuple[Pattern[str], type[autodoc2.render.base.RendererBase]]] = None¶
- module_all_regexes: list[Pattern[str]] = None¶
- skip_module_regexes: list[Pattern[str]] = None¶
- no_index: bool = None¶
- deprecated_module_regexes: list[Pattern[str]] = None¶
- module_summary: bool = None¶
- docstring_parser_regexes: list[tuple[Pattern[str], str]] = None¶
- class_docstring: Literal[merge, both] = None¶
- class_inheritance: bool = None¶
- annotations: bool = None¶
- docstrings: Literal[all, direct, none] = None¶
- sort_names: bool = None¶
- replace_annotations: list[tuple[str, str]] = None¶
- replace_bases: list[tuple[str, str]] = None¶
- index_template: str | None = None¶