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.

Files for doxygen-interface, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size doxygen-interface-0.0.1.tar.gz (6.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page