Open JakubAndrysek opened 1 week ago
This pull request rewrites the core of the MkDoxy plugin to improve configuration processing, mark outdated config options, and add new ones. It also introduces a migration tool to convert old config to the new format. The changes include refactoring classes and methods to use the new configuration structure, updating method names to follow snake_case convention, adding detailed docstrings, and updating tests and documentation accordingly.
Files | Changes |
---|---|
mkdoxy/plugin.py mkdoxy/generatorSnippets.py mkdoxy/doxyrun.py mkdoxy/generatorBase.py mkdoxy/utils.py mkdoxy/generatorAuto.py mkdoxy/node.py mkdoxy/finder.py mkdoxy/doxygen.py |
Refactored classes and methods to use new configuration structure, updated method names to follow snake_case convention, and added detailed docstrings. |
tests/test_doxyrun.py tests/test_migration.py tests/data/migration/mkdocs2-new.yaml tests/data/migration/mkdocs2-old.yaml tests/data/migration/mkdocs1-new.yaml tests/data/migration/mkdocs1-old.yaml |
Updated tests to use new configuration structure and added new tests for configuration migration. |
mkdocs.yml docs/usage/index.md setup.py README.md |
Updated configuration options to use new keys and added instructions for new features. |
mkdoxy/DoxyTagParser.py mkdoxy/constants.py mkdoxy/project.py mkdoxy/migration.py mkdoxy/cli.py |
Added new files and updated existing ones to support configuration migration and CLI commands. |
Rewrite the core of MkDoxy plugin
Summary by Sourcery
This pull request rewrites the core of the MkDoxy plugin, improving configuration processing, marking outdated config options, and adding new ones. It also introduces a migration tool to convert old configurations to the new format, enhances logging and error handling, and refactors the template loading mechanism.