doxygen-interface 0.0.1

Library used to manipulate Doxygen configuration and build

This library provide a way to update Doxygen configuration and launch a build of documentation

Example

from doxygen import ConfigParser
from doxygen import Generator


my_doxyfile_path = "path/to/my/Doxyfile"

# 1. Load the configuration from your Doxyfile
config_parser = ConfigParser()
configuration = config_parser.load_configuration(my_doxyfile_path)

# 2. Update the configuration
configuration['PROJECT_NUMBER'] = '1.2.3.4'
configuration['BRIEF_MEMBER_DESC'] = 'NO'
configuration['FILE_PATTERNS'].append('*.abc')

# 3. Store the configure
config_parser.store_configuration(configuration, my_doxyfile_path)

# 4. Build the doc and generate a zip
doxy_builder = Generator(my_doxyfile_path)
output_zip_archive = doxy_builder.build(clean=True, generate_zip=True)