Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# `autodoc2.config`

## Module Contents

### Classes

`PackageConfig` |
`Config` |

### Functions

`_coerce_packages` |
`_validate_replace_list` |
`_validate_hidden_objects` |
`_validate_regex_list` |
`_validate_list_tuple_regex_str` |
`_load_renderer` |
`_load_regex_renderers` |

### Data

`CONFIG_PREFIX` |

### API

exception autodoc2.config.ValidationError

  Bases: `Exception`

  Initialization

autodoc2.config.CONFIG_PREFIX = 'autodoc2_'

class autodoc2.config.PackageConfig
  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
  as_triple() → Iterable[tuple[str, Any, dataclasses.Field]]

autodoc2.config._coerce_packages(name: str, item: Any) → list[autodoc2.config.PackageConfig]

autodoc2.config._validate_replace_list(name: str, item: Any) → list[tuple[str, str]]

autodoc2.config._validate_hidden_objects(name: str, item: Any) → set[str]

autodoc2.config._validate_regex_list(name: str, item: Any) → list[Pattern[str]]

autodoc2.config._validate_list_tuple_regex_str(name: str, item: Any) → list[tuple[Pattern[str], str]]

autodoc2.config._load_renderer(name: str, item: Any) → type[autodoc2.render.base.RendererBase]

autodoc2.config._load_regex_renderers(name: str, item: Any) → list[tuple[Pattern[str], type[autodoc2.render.base.RendererBase]]]

class autodoc2.config.Config
  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
  hidden_objects: set[Literal[undoc, dunder, private, inherited]] = None
  hidden_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
  as_triple() → Iterable[tuple[str, Any, dataclasses.Field]]