JakubAndrysek / MkDoxy

📖 Automatically generates API documentation for your project based on Doxygen comments and code snippets in your markdown files.
https://mkdoxy.kubaandrysek.cz/
MIT License
60 stars 16 forks source link

Update MkDoxy core #110

Open JakubAndrysek opened 1 week ago

JakubAndrysek commented 1 week ago

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.

sourcery-ai[bot] commented 1 week ago

Reviewer's Guide by Sourcery

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.

File-Level Changes

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.

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - You can change your review settings at any time by accessing your [dashboard](https://sourcery.ai/dashboard): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.