src.utils.update_conf_content

Module Contents

src.utils.update_conf_content.REQUIRED_EXTENSIONS = ('autoapi.extension', 'sphinx.ext.napoleon')

src.utils.update_conf_content.AUTOAPI_DIRS_LINE = "autoapi_dirs = ['../autoapi_include']"

src.utils.update_conf_content.AUTOAPI_ADD_TOCTREE_LINE = 'autoapi_add_toctree_entry = False'

src.utils.update_conf_content.update_conf(conf_py: str) → None

Update the configuration file by modifying its content if necessary.

Parameters:

conf_py (str) – The path to the configuration file.

Returns:

This function does not return a value.

Return type:

None