Metadata-Version: 1.2
Name: doxygen-interface
Version: 0.0.0.dev0
Summary: Library used to manipulate Doxygen configuration and build
Home-page: https://github.com/TraceSoftwareInternational/doxygen-python-interface
Author: Trace Software International
Author-email: dducatel@trace-software.com
License: UNKNOWN
Description: doxygen-python-interface
        ========================
        
        |Build Status|
        
        This library provide a way to update `Doxygen`_ configuration and launch
        a build of documentation
        
        Example
        -------
        
        .. code:: python
        
        
            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)
        
        .. _Doxygen: http://www.stack.nl/~dimitri/doxygen/
        
        .. |Build Status| image:: https://travis-ci.org/TraceSoftwareInternational/doxygen-python-interface.svg?branch=master
           :target: https://travis-ci.org/TraceSoftwareInternational/doxygen-python-interface
        
Keywords: doxygen documentation api
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.5
