Library used to manipulate Doxygen configuration and build
Project description
This library provide a way to update Doxygen configuration and launch a build of documentation
Example
from doxygen.configParser import ConfigParser
from doxygen.generator 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for doxygen-interface-0.0.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5bdc16a67e88605a3847e7f6e953922bd2ecfb2a33c018f1cbfb301742e2e8ef |
|
MD5 | 762eebd634691ec6ab2fee9ff8b83873 |
|
BLAKE2b-256 | ffbd1658a25f1f49a61c9b529e7978959315a1bd44ab9cda99305d5faab63882 |