cminx.config

Contains config objects, their defaults, the config template for confuse, and a function to convert a dictionary to a Settings object.

The settings object mirrors the template and the config_default.yaml file. Visit that file for information on what each setting does.

class cminx.config.InputSettings(include_undocumented_function: bool = True, include_undocumented_macro: bool = True, include_undocumented_cpp_class: bool = True, include_undocumented_cpp_attr: bool = True, include_undocumented_cpp_constructor: bool = True, include_undocumented_cpp_member: bool = True, include_undocumented_ct_add_test: bool = True, include_undocumented_ct_add_section: bool = True, include_undocumented_add_test: bool = True, include_undocumented_option: bool = True, auto_exclude_directories_without_cmake: bool = True, kwargs_doc_trigger_string: str = ':param **kwargs:', exclude_filters: List[str] = (), function_parameter_name_strip_regex: str = '', macro_parameter_name_strip_regex: str = '', member_parameter_name_strip_regex: str = '', recursive: bool = False, follow_symlinks: bool = False)

class cminx.config.OutputSettings(directory: str = None, relative_to_config: bool = False)

class cminx.config.RSTSettings(file_extensions_in_titles: bool = False, file_extensions_in_modules: bool = False, prefix: str = None, module_path_separator: str = '.', headers: List[str] = ('#', '*', '=', '-', '_', '~', '!', '&', '@', '^'))

class cminx.config.Settings(input: cminx.config.InputSettings = <factory>, output: cminx.config.OutputSettings = <factory>, logging: cminx.config.LoggingSettings = <factory>, rst: cminx.config.RSTSettings = <factory>)

cminx.config.config_template(output_dir_relative_to_config: bool = False) → dict

Generates the config template.

Parameters:: output_dir_relative_to_config – Selects whether output.dir should be resolved relative to the config source,

if not then it is resolved relative to the current working directory.