Skip to main content

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)

Metadata

Release files for doxygen-interface 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for doxygen-interface 0.0.1
File Size Uploaded
doxygen-interface-0.0.1.tar.gz 6.8 kB Details

Release files / doxygen-interface-0.0.1.tar.gz

Download URL doxygen-interface-0.0.1.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
4b4b8e9d9d9043ce65dcfae083f33b1bd40e4b0db01cfcd664cf4eb2adaa4fad
BLAKE2b-256 checksum
How to use checksums
e1201e6a6670c401f28618656885ba4f383ad26f9d55da118b782413453ea7c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.0.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page