genpydoc.config package

Submodules

genpydoc.config.config module

class genpydoc.config.config.Config(exclude: list[str] = [], docstring_style: str = 'sphinx', ignore_magic: bool = False, ignore_module: bool = True, ignore_private: bool = False, ignore_semiprivate: bool = False, ignore_init_method: bool = True, ignore_nested_classes: bool = False, ignore_nested_functions: bool = False, ignore_property_setters: bool = False, ignore_property_decorators: bool = False, ignore_overloaded_functions: bool = False, include_only_covered: bool = False, run_on_diff: bool = False, run_staged: bool = False, target_branch: str | None = 'main', use_llm_provider: Literal['openai'] = 'openai', use_model: str = 'gpt-5-nano', post_processing: PostProcessingConfig = <genpydoc.config.config.PostProcessingConfig object>)

Bases: object

VALID_LLM_PROVIDERS = ('openai',)

VALID_STYLES = ('sphinx', 'google')

docstring_style: str

exclude: list[str]

ignore_init_method: bool

ignore_magic: bool

ignore_module: bool

ignore_nested_classes: bool

ignore_nested_functions: bool

ignore_overloaded_functions: bool

ignore_private: bool

ignore_property_decorators: bool

ignore_property_setters: bool

ignore_semiprivate: bool

include_only_covered: bool

post_processing: PostProcessingConfig

root: str = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/genpydoc/checkouts/latest')

run_on_diff: bool

run_staged: bool

target_branch: str | None

use_llm_provider: Literal['openai']

use_model: str

class genpydoc.config.config.PostProcessingConfig

Bases: object

cleanup: bool = _CountingAttr(counter=27, _default=True, repr=True, eq=True, order=True, hash=None, init=True, on_setattr=None, alias=None, metadata={})

convert: bool = _CountingAttr(counter=28, _default=True, repr=True, eq=True, order=True, hash=None, init=True, on_setattr=None, alias=None, metadata={})

genpydoc.config.config.parse_pyproject_toml(path_config: str) → dict[str, Any] | None