Skip to main content

Library used to manipulate Doxygen configuration and build

Project description

BuildStatus PyPILastVersion License Docs

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doxygen-interface-0.0.1.tar.gz (6.8 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page