From c5e574f1310137c1a3c26521e157013ea682cc68 Mon Sep 17 00:00:00 2001
From: Jakub Andrysek <jakub.andrysek03@gmail.com>
Date: Wed, 3 Apr 2024 01:11:51 +0200
Subject: [PATCH 1/4] Add Doxyfile configurations and update Doxygen plugin

---
 .idea/misc.xml                |   5 +-
 .idea/workspace.xml           | 126 +++++++++++++++++++++++++--------
 demo-projects/animal/Doxyfile |   7 ++
 docs/usage/advanced.md        |  18 ++++-
 mkdocs.yml                    |   1 +
 mkdoxy/doxyrun.py             | 129 ++++++++++++++++++++++++++--------
 mkdoxy/generatorBase.py       |  11 +--
 mkdoxy/plugin.py              |   2 +
 tests/data/Doxyfile           |   7 ++
 tests/test_doxyrun.py         |  77 ++++++++++++++++++++
 10 files changed, 318 insertions(+), 65 deletions(-)
 create mode 100644 demo-projects/animal/Doxyfile
 create mode 100644 tests/data/Doxyfile
 create mode 100644 tests/test_doxyrun.py

diff --git a/.idea/misc.xml b/.idea/misc.xml
index f88c0a0d..a6218fed 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -1,4 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
+  <component name="Black">
+    <option name="sdkName" value="Python 3.11" />
+  </component>
   <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.11" project-jdk-type="Python SDK" />
-</project>
+</project>
\ No newline at end of file
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index c29d74d2..c759aebb 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -5,9 +5,16 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="5a348fe7-ee21-4e06-b8fc-ced5d548a610" name="Changes" comment="Upgrade version">
-      <change beforePath="$PROJECT_DIR$/.github/workflows/mkdoxy-test-demos.yaml" beforeDir="false" afterPath="$PROJECT_DIR$/.github/workflows/mkdoxy-test-demos.yaml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.github/workflows/mkdoxy-test-repo.yaml" beforeDir="false" afterPath="$PROJECT_DIR$/.github/workflows/mkdoxy-test-repo.yaml" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/demo-projects/animal/Doxyfile" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/tests/data/Doxyfile" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/tests/test_doxyrun.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/usage/advanced.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/usage/advanced.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/mkdocs.yml" beforeDir="false" afterPath="$PROJECT_DIR$/mkdocs.yml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/mkdoxy/doxyrun.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/doxyrun.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/mkdoxy/generatorBase.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/generatorBase.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/mkdoxy/plugin.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/plugin.py" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -43,6 +50,9 @@
   <component name="MarkdownSettingsMigration">
     <option name="stateVersion" value="1" />
   </component>
+  <component name="ProjectColorInfo"><![CDATA[{
+  "associatedIndex": 3
+}]]></component>
   <component name="ProjectId" id="20sSF9RtRyYPthPvI9bA0t9QgTh" />
   <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
   <component name="ProjectViewState">
@@ -50,37 +60,42 @@
     <option name="hideEmptyMiddlePackages" value="true" />
     <option name="showLibraryContents" value="true" />
   </component>
-  <component name="PropertiesComponent">{
-  &quot;keyToString&quot;: {
-    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
-    &quot;SHARE_PROJECT_CONFIGURATION_FILES&quot;: &quot;true&quot;,
-    &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
-    &quot;git-widget-placeholder&quot;: &quot;main&quot;,
-    &quot;last_opened_file_path&quot;: &quot;/Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-new-templates/docs&quot;,
-    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
-    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
-    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
-    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
-    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
-    &quot;settings.editor.selected.configurable&quot;: &quot;reference.settings.ide.settings.new.ui&quot;,
-    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "Python tests.pytest in /.executor": "Run",
+    "Python.mkdocs-serve-vPy3.11.executor": "Run",
+    "Python.mkdoxy-demo-vPy3.11.executor": "Debug",
+    "RunOnceActivity.OpenProjectViewOnStart": "true",
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "SHARE_PROJECT_CONFIGURATION_FILES": "true",
+    "WebServerToolWindowFactoryState": "false",
+    "git-widget-placeholder": "main",
+    "last_opened_file_path": "/Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-main/tests/data",
+    "node.js.detected.package.eslint": "true",
+    "node.js.detected.package.tslint": "true",
+    "node.js.selected.package.eslint": "(autodetect)",
+    "node.js.selected.package.tslint": "(autodetect)",
+    "nodejs_package_manager_path": "npm",
+    "settings.editor.selected.configurable": "reference.settings.ide.settings.new.ui",
+    "vue.rearranger.settings.migration": "true"
   }
-}</component>
+}]]></component>
   <component name="RecentsManager">
     <key name="CopyFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/tests/data" />
       <recent name="$PROJECT_DIR$/docs" />
       <recent name="$PROJECT_DIR$/demo" />
       <recent name="$PROJECT_DIR$/docs/snippets" />
       <recent name="$PROJECT_DIR$/local" />
-      <recent name="$PROJECT_DIR$" />
     </key>
     <key name="MoveFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/tests" />
       <recent name="$PROJECT_DIR$/local" />
       <recent name="$PROJECT_DIR$/docs/snippets" />
       <recent name="$PROJECT_DIR$/docs" />
     </key>
   </component>
-  <component name="RunManager" selected="Python.mkdoxy-demo-vPy3.11">
+  <component name="RunManager" selected="Python.mkdocs-serve-vPy3.11">
     <configuration name="install" type="MAKEFILE_TARGET_RUN_CONFIGURATION" factoryName="Makefile">
       <makefile filename="$PROJECT_DIR$/Makefile" target="install" workingDirectory="" arguments="">
         <envs />
@@ -95,6 +110,7 @@
     </configuration>
     <configuration name="mkdocs-serve-vPy3.11" type="PythonConfigurationType" factoryName="Python">
       <module name="main-mkdoxy" />
+      <option name="ENV_FILES" value="" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
       <envs>
@@ -117,6 +133,7 @@
     </configuration>
     <configuration name="mkdoxy-demo-vPy3.11" type="PythonConfigurationType" factoryName="Python">
       <module name="main-mkdoxy" />
+      <option name="ENV_FILES" value="" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
       <envs>
@@ -139,6 +156,7 @@
     </configuration>
     <configuration name="Python tests for local.test_DoxyTageParser" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
       <module name="main-mkdoxy" />
+      <option name="ENV_FILES" value="" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
       <option name="SDK_HOME" value="" />
@@ -184,6 +202,7 @@
     </configuration>
     <configuration name="Python tests for local.test_generatorSnippets.TestGeneratorCommand" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
       <module name="main-mkdoxy" />
+      <option name="ENV_FILES" value="" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
       <option name="SDK_HOME" value="" />
@@ -199,6 +218,7 @@
     </configuration>
     <configuration name="Python tests for test_DoxyTageParser.Test.test_parse_empty_tag" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
       <module name="main-mkdoxy" />
+      <option name="ENV_FILES" value="" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
       <option name="SDK_HOME" value="" />
@@ -212,8 +232,9 @@
       <option name="_new_targetType" value="&quot;PYTHON&quot;" />
       <method v="2" />
     </configuration>
-    <configuration name="Python tests in test_DoxyTageParser.py" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
+    <configuration name="Python tests in /Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-main/local/test_DoxyTageParser.py" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
       <module name="main-mkdoxy" />
+      <option name="ENV_FILES" value="" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
       <option name="SDK_HOME" value="" />
@@ -227,26 +248,53 @@
       <option name="_new_targetType" value="&quot;PATH&quot;" />
       <method v="2" />
     </configuration>
+    <configuration name="pytest in /" type="tests" factoryName="py.test" nameIsGenerated="true">
+      <module name="main-mkdoxy" />
+      <option name="ENV_FILES" value="" />
+      <option name="INTERPRETER_OPTIONS" value="" />
+      <option name="PARENT_ENVS" value="true" />
+      <option name="SDK_HOME" value="/opt/homebrew/bin/python3.11" />
+      <option name="SDK_NAME" value="Python 3.11" />
+      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/" />
+      <option name="IS_MODULE_SDK" value="false" />
+      <option name="ADD_CONTENT_ROOTS" value="true" />
+      <option name="ADD_SOURCE_ROOTS" value="true" />
+      <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+      <option name="_new_keywords" value="&quot;&quot;" />
+      <option name="_new_parameters" value="&quot;&quot;" />
+      <option name="_new_additionalArguments" value="&quot;&quot;" />
+      <option name="_new_target" value="&quot;&quot;" />
+      <option name="_new_targetType" value="&quot;PATH&quot;" />
+      <method v="2" />
+    </configuration>
     <list>
       <item itemvalue="Makefile Target.install" />
       <item itemvalue="Makefile Target.reviewCode" />
       <item itemvalue="Python.mkdocs-serve-vPy3.11" />
       <item itemvalue="Python.mkdoxy-demo-vPy3.11" />
+      <item itemvalue="Python tests.pytest in /" />
+      <item itemvalue="Python tests.Python tests in /Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-main/local/test_DoxyTageParser.py" />
       <item itemvalue="Python tests.Python tests for test_DoxyTageParser.Test.test_parse_empty_tag" />
       <item itemvalue="Python tests.Python tests for local.test_DoxyTageParser" />
       <item itemvalue="Python tests.Python tests for local.test_generatorSnippets.TestGeneratorCommand" />
-      <item itemvalue="Python tests.Python tests in test_DoxyTageParser.py" />
     </list>
     <recent_temporary>
       <list>
         <item itemvalue="Makefile Target.reviewCode" />
         <item itemvalue="Python tests.Python tests for local.test_generatorSnippets.TestGeneratorCommand" />
-        <item itemvalue="Python tests.Python tests in test_DoxyTageParser.py" />
+        <item itemvalue="Python tests.Python tests in /Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-main/local/test_DoxyTageParser.py" />
         <item itemvalue="Python tests.Python tests for local.test_DoxyTageParser" />
         <item itemvalue="Python tests.Python tests for local.test_DoxyTageParser" />
       </list>
     </recent_temporary>
   </component>
+  <component name="SharedIndexes">
+    <attachedChunks>
+      <set>
+        <option value="bundled-python-sdk-5a2391486177-2887949eec09-com.jetbrains.pycharm.pro.sharedIndexes.bundled-PY-233.13763.11" />
+      </set>
+    </attachedChunks>
+  </component>
   <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
   <component name="TaskManager">
     <task active="true" id="Default" summary="Default task">
@@ -276,6 +324,7 @@
       <workItem from="1689697868617" duration="13000" />
       <workItem from="1689777262215" duration="704000" />
       <workItem from="1689947020589" duration="1060000" />
+      <workItem from="1712098386110" duration="1058000" />
     </task>
     <task id="LOCAL-00001" summary="Optimise code by sourcery.ai">
       <created>1674630349699</created>
@@ -547,6 +596,21 @@
           <line>22</line>
           <option name="timeStamp" value="90" />
         </line-breakpoint>
+        <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
+          <url>file://$PROJECT_DIR$/mkdoxy/doxyrun.py</url>
+          <line>93</line>
+          <option name="timeStamp" value="101" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
+          <url>file://$PROJECT_DIR$/mkdoxy/doxyrun.py</url>
+          <line>110</line>
+          <option name="timeStamp" value="102" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
+          <url>file://$PROJECT_DIR$/tests/test_doxyrun.py</url>
+          <line>12</line>
+          <option name="timeStamp" value="103" />
+        </line-breakpoint>
         <line-breakpoint enabled="true" type="jinja2-line">
           <url>file://$PROJECT_DIR$/mkdoxy/templates/relatedPages.jinja2</url>
           <line>5</line>
@@ -562,16 +626,18 @@
     </watches-manager>
   </component>
   <component name="com.intellij.coverage.CoverageDataManagerImpl">
-    <SUITE FILE_PATH="coverage/main_mkdoxy$snippetsTest_examples.coverage" NAME="snippetsTest-examples Coverage Results" MODIFIED="1681283640299" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests-old" />
-    <SUITE FILE_PATH="coverage/mkdoxy_main$mkdoxy_demo_vPy3_11.coverage" NAME="mkdoxy-demo-vPy3.11 Coverage Results" MODIFIED="1689947322850" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/../../mkdoxy-demo" />
+    <SUITE FILE_PATH="coverage/mkdoxy_main$snippetsTest_examples.coverage" NAME="snippetsTest-examples Coverage Results" MODIFIED="1683122953058" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests-old" />
+    <SUITE FILE_PATH="coverage/mkdoxy_new_templates$mkdocs_serve_vPy3_11.coverage" NAME="mkdocs-serve-vPy3.11 Coverage Results" MODIFIED="1688123597182" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
     <SUITE FILE_PATH="coverage/main_mkdoxy$mkdoxy_demo_vPy3_11.coverage" NAME="mkdoxy-demo-vPy3.11 Coverage Results" MODIFIED="1680895787944" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/../mkdoxy-demo" />
+    <SUITE FILE_PATH="coverage/main_mkdoxy$snippetsTest_examples.coverage" NAME="snippetsTest-examples Coverage Results" MODIFIED="1681283640299" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests-old" />
+    <SUITE FILE_PATH="coverage/mkdoxy_main$mkdoxy_cer_vPy3_11.coverage" NAME="mkdoxy-cer-vPy3.11 Coverage Results" MODIFIED="1712087157586" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/../../../../_other/py/queryosity" />
+    <SUITE FILE_PATH="coverage/mkdoxy_new_templates$mkdoxy_demo_vPy3_11.coverage" NAME="mkdoxy-demo-vPy3.11 Coverage Results" MODIFIED="1688123563232" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/../../mkdoxy-demo" />
     <SUITE FILE_PATH="coverage/main_mkdoxy$mkdocs_serve_vPy3_11.coverage" NAME="mkdocs-serve-vPy3.11 Coverage Results" MODIFIED="1680351126249" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
     <SUITE FILE_PATH="coverage/mkdoxy_new_templates$.coverage" NAME=" Coverage Results" MODIFIED="1685351058154" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests" />
-    <SUITE FILE_PATH="coverage/mkdoxy_new_templates$mkdoxy_demo_vPy3_11.coverage" NAME="mkdoxy-demo-vPy3.11 Coverage Results" MODIFIED="1688123563232" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/../../mkdoxy-demo" />
-    <SUITE FILE_PATH="coverage/mkdoxy_new_templates$mkdocs_serve_vPy3_11.coverage" NAME="mkdocs-serve-vPy3.11 Coverage Results" MODIFIED="1688123597182" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
-    <SUITE FILE_PATH="coverage/mkdoxy_main$mkdocs_serve_vPy3_11.coverage" NAME="mkdocs-serve-vPy3.11 Coverage Results" MODIFIED="1689593068923" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
-    <SUITE FILE_PATH="coverage/main_mkdoxy$mkdocs_serve_py3_9.coverage" NAME="mkdocs-serve-py3.9 Coverage Results" MODIFIED="1636834417383" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests/files" />
-    <SUITE FILE_PATH="coverage/mkdoxy_main$snippetsTest_examples.coverage" NAME="snippetsTest-examples Coverage Results" MODIFIED="1683122953058" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests-old" />
     <SUITE FILE_PATH="coverage/main_mkdoxy$mkdocs_serve_vPy3_9.coverage" NAME="mkdocs-serve-vPy3.9 Coverage Results" MODIFIED="1636834436573" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests/files" />
+    <SUITE FILE_PATH="coverage/main_mkdoxy$mkdocs_serve_py3_9.coverage" NAME="mkdocs-serve-py3.9 Coverage Results" MODIFIED="1636834417383" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests/files" />
+    <SUITE FILE_PATH="coverage/mkdoxy_main$mkdoxy_demo_vPy3_11.coverage" NAME="mkdoxy-demo-vPy3.11 Coverage Results" MODIFIED="1712095688009" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/../../mkdoxy-demo" />
+    <SUITE FILE_PATH="coverage/mkdoxy_main$pytest_in__.coverage" NAME="pytest in / Coverage Results" MODIFIED="1712098709702" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
+    <SUITE FILE_PATH="coverage/mkdoxy_main$mkdocs_serve_vPy3_11.coverage" NAME="mkdocs-serve-vPy3.11 Coverage Results" MODIFIED="1712099288194" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
   </component>
-</project>
+</project>
\ No newline at end of file
diff --git a/demo-projects/animal/Doxyfile b/demo-projects/animal/Doxyfile
new file mode 100644
index 00000000..20dc954b
--- /dev/null
+++ b/demo-projects/animal/Doxyfile
@@ -0,0 +1,7 @@
+DOXYFILE_ENCODING = UTF-8
+GENERATE_XML = YES
+RECURSIVE = YES
+EXAMPLE_PATH = examples
+SHOW_NAMESPACES = YES
+GENERATE_HTML = NO
+GENERATE_LATEX = YES
\ No newline at end of file
diff --git a/docs/usage/advanced.md b/docs/usage/advanced.md
index 4a4d5838..a5dd5cb6 100644
--- a/docs/usage/advanced.md
+++ b/docs/usage/advanced.md
@@ -7,7 +7,7 @@
 ## Disabling the plugin
 You can use the `enabled` option to optionally disable this plugin. A possible use case is local development where you might want faster build times.
 
-```yaml
+```yaml hl_lines="3"
 plugins:
   - mkdoxy:
       enabled: !ENV [ENABLE_MKDOXY, True]
@@ -29,9 +29,23 @@ If `doxygen-bin-path` is not found, the plugin will raise DoxygenBinPathNotValid
 
 - addad by [thb-sb](https://github.com/thb-sb)
 
-```yaml
+```yaml hl_lines="3"
 plugins:
   - mkdoxy:
       doxygen-bin-path: /path/to/doxygen
       ...
 ```
+
+## Configure custom Doxygen configuration file
+If you want to use a standard Doxygen configuration file, you can specify the path to the file using the `doxygen-config` option in the plugin configuration.
+
+```yaml hl_lines="6"
+plugins:
+  - mkdoxy:
+      projects:
+        myProjectCpp:
+          src-dirs: ...
+          doxy-cfg-file: path/to/Doxyfile  # relative path to the Doxygen configuration file (relative to the mkdocs.yml file)
+          doxy-cfg:       # standard doxygen configuration (key: value)
+            FILE_PATTERNS: ... # other configuration options - merge (this will override the configuration from the Doxyfile)
+```
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index aa58b568..0c4a8e26 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -67,6 +67,7 @@ plugins:
           src-dirs: mkdoxy
           full-doc: True
           # template-dir: templates-custom
+          doxy-cfg-file: demo-projects/animal/Doxyfile
           doxy-cfg:
             FILE_PATTERNS: "*.py"
             EXAMPLE_PATH: ""
diff --git a/mkdoxy/doxyrun.py b/mkdoxy/doxyrun.py
index a9a631aa..ef901857 100644
--- a/mkdoxy/doxyrun.py
+++ b/mkdoxy/doxyrun.py
@@ -12,7 +12,7 @@
 
 class DoxygenRun:
     """! Class for running Doxygen.
-    @details This class is used to run Doxygen and parse the XML output.
+    @detailss This class is used to run Doxygen and parse the XML output.
     """
 
     def __init__(
@@ -21,6 +21,7 @@ def __init__(
         doxygenSource: str,
         tempDoxyFolder: str,
         doxyCfgNew,
+        doxyConfigFile: Optional[str] = None,
         runPath: Optional[str] = None,
     ):
         """! Constructor.
@@ -36,10 +37,11 @@ def __init__(
         - GENERATE_HTML: NO
         - GENERATE_LATEX: NO
 
-        @details
+        @detailss
         @param doxygenBinPath: (str) Path to the Doxygen binary.
         @param doxygenSource: (str) Source files for Doxygen.
         @param tempDoxyFolder: (str) Temporary folder for Doxygen.
+        @param doxyConfigFile: (str) Path to a Doxygen config file.
         @param doxyCfgNew: (dict) New Doxygen config options that will be added to the default config (new options will overwrite default options)
         """  # noqa: E501
 
@@ -53,28 +55,67 @@ def __init__(
         self.doxygenBinPath: str = doxygenBinPath
         self.doxygenSource: str = doxygenSource
         self.tempDoxyFolder: str = tempDoxyFolder
-        self.doxyCfgNew: dict = doxyCfgNew
+        self.doxyConfigFile: Optional[str] = doxyConfigFile
         self.hashFileName: str = "hashChanges.yaml"
         self.hashFilePath: PurePath = PurePath.joinpath(Path(self.tempDoxyFolder), Path(self.hashFileName))
         self.runPath: Optional[str] = runPath
+        self.doxyCfg: dict = self.setDoxyCfg(doxyCfgNew)
 
-        self.doxyCfg: dict = {
-            "INPUT": self.doxygenSource,
-            "OUTPUT_DIRECTORY": self.tempDoxyFolder,
-            "DOXYFILE_ENCODING": "UTF-8",
-            "GENERATE_XML": "YES",
-            "RECURSIVE": "YES",
-            "SHOW_NAMESPACES": "YES",
-            "GENERATE_HTML": "NO",
-            "GENERATE_LATEX": "NO",
-        }
+    def setDoxyCfg(self, doxyCfgNew: dict) -> dict:
+        """! Set the Doxygen configuration.
+        @details If a custom Doxygen config file is provided, it will be used. Otherwise, default options will be used.
+        @details Order of application of parameters:
+        @details 1. Custom Doxygen config file
+        @details 2. If not provided, default options - in documentation
+        @details 3. New Doxygen config options from mkdocs.yml
+        @details 3. Overwrite INPUT and OUTPUT_DIRECTORY with the provided values for correct plugin operation.
 
-        self.doxyCfg.update(self.doxyCfgNew)
-        self.doxyCfgStr: str = self.dox_dict2str(self.doxyCfg)
+        @details Overwrite options description:
+        @details - INPUT: <doxygenSource>
+        @details - OUTPUT_DIRECTORY: <tempDoxyFolder>
+
+        @details Default Doxygen config options:
+        @details - DOXYFILE_ENCODING: UTF-8
+        @details - GENERATE_XML: YES
+        @details - RECURSIVE: YES
+        @details - EXAMPLE_PATH: examples
+        @details - SHOW_NAMESPACES: YES
+        @details - GENERATE_HTML: NO
+        @details - GENERATE_LATEX: NO
+        @param doxyCfgNew: (dict) New Doxygen config options that will be added to the default config (new options will overwrite default options)
+        @return: (dict) Doxygen configuration.
+        """
+        doxyCfg = {}
+
+        if self.doxyConfigFile is not None and self.doxyConfigFile != "":
+            try:
+                with open(self.doxyConfigFile, "r") as file:
+                    doxyCfg.update(self.str2dox_dict(file.read()))
+            except FileNotFoundError as e:
+                raise DoxygenCustomConfigNotFound(
+                    f"Custom Doxygen config file not found: {self.doxyConfigFile}\n"
+                    f"Make sure the path is correct."
+                    f"Look at https://mkdoxy.kubaandrysek.cz/usage/advanced/#configure-custom-doxygen-configuration-file."
+                ) from e
+        else:
+            doxyCfg = {
+                "DOXYFILE_ENCODING": "UTF-8",
+                "GENERATE_XML": "YES",
+                "RECURSIVE": "YES",
+                "EXAMPLE_PATH": "examples",
+                "SHOW_NAMESPACES": "YES",
+                "GENERATE_HTML": "NO",
+                "GENERATE_LATEX": "NO",
+            }
+
+        doxyCfg.update(doxyCfgNew)
+        doxyCfg["INPUT"] = self.doxygenSource
+        doxyCfg["OUTPUT_DIRECTORY"] = self.tempDoxyFolder
+        return doxyCfg
 
     def is_doxygen_valid_path(self, doxygen_bin_path: str) -> bool:
         """! Check if the Doxygen binary path is valid.
-        @details Accepts a full path or just 'doxygen' if it exists in the system's PATH.
+        @detailss Accepts a full path or just 'doxygen' if it exists in the system's PATH.
         @param doxygen_bin_path: (str) The path to the Doxygen binary or just 'doxygen'.
         @return: (bool) True if the Doxygen binary path is valid, False otherwise.
         """
@@ -89,7 +130,7 @@ def is_doxygen_valid_path(self, doxygen_bin_path: str) -> bool:
     # Source of dox_dict2str: https://xdress-fabio.readthedocs.io/en/latest/_modules/xdress/doxygen.html#XDressPlugin
     def dox_dict2str(self, dox_dict: dict) -> str:
         """! Convert a dictionary to a string that can be written to a doxygen config file.
-        @details
+        @detailss
         @param dox_dict: (dict) Dictionary to convert.
         @return: (str) String that can be written to a doxygen config file.
         """
@@ -108,17 +149,43 @@ def dox_dict2str(self, dox_dict: dict) -> str:
         # Don't need an empty line at the end
         return s.strip()
 
+    def str2dox_dict(self, dox_str: str) -> dict:
+        """! Convert a string from a doxygen config file to a dictionary.
+        @detailss
+        @param dox_str: (str) String from a doxygen config file.
+        @return: (dict) Dictionary.
+        """
+        dox_dict = {}
+        try:
+            for line in dox_str.split("\n"):
+                if line.strip() == "":
+                    continue
+                key, value = line.split(" = ")
+                if value == "YES":
+                    dox_dict[key] = True
+                elif value == "NO":
+                    dox_dict[key] = False
+                else:
+                    dox_dict[key] = value
+        except ValueError as e:
+            raise DoxygenCustomConfigNotValid(
+                f"Invalid custom Doxygen config file: {self.doxyConfigFile}\n"
+                f"Make sure the file is in standard Doxygen format."
+                f"Look at https://mkdoxy.kubaandrysek.cz/usage/advanced/."
+            ) from e
+        return dox_dict
+
     def hasChanged(self):
         """! Check if the source files have changed since the last run.
-        @details
+        @detailss
         @return: (bool) True if the source files have changed since the last run.
         """
 
-        def heshWrite(filename: str, hash: str):
+        def hashWrite(filename: PurePath, hash: str):
             with open(filename, "w") as file:
                 file.write(hash)
 
-        def hashRead(filename: str) -> str:
+        def hashRead(filename: PurePath) -> str:
             with open(filename, "r") as file:
                 return str(file.read())
 
@@ -128,7 +195,7 @@ def hashRead(filename: str) -> str:
             for path in Path(src).rglob("*.*"):
                 # # Code from https://stackoverflow.com/a/22058673/15411117
                 # # BUF_SIZE is totally arbitrary, change for your app!
-                BUF_SIZE = 65536  # lets read stuff in 64kb chunks!
+                BUF_SIZE = 65536  # let's read stuff in 64kb chunks!
                 if path.is_file():
                     with open(path, "rb") as f:
                         while True:
@@ -138,18 +205,18 @@ def hashRead(filename: str) -> str:
                             sha1.update(data)
                 # print(f"{path}: {sha1.hexdigest()}")
 
-        hahsNew = sha1.hexdigest()
+        hashNew = sha1.hexdigest()
         if Path(self.hashFilePath).is_file():
             hashOld = hashRead(self.hashFilePath)
-            if hahsNew == hashOld:
+            if hashNew == hashOld:
                 return False
 
-        heshWrite(self.hashFilePath, hahsNew)
+        hashWrite(self.hashFilePath, hashNew)
         return True
 
     def run(self):
         """! Run Doxygen with the current configuration using the Popen class.
-        @details
+        @detailss
         """
         doxyBuilder = Popen(
             [self.doxygenBinPath, "-"],
@@ -158,13 +225,13 @@ def run(self):
             stderr=PIPE,
             cwd=self.runPath,
         )
-        (doxyBuilder.communicate(self.doxyCfgStr.encode("utf-8"))[0].decode().strip())
+        (doxyBuilder.communicate(self.dox_dict2str(self.doxyCfg).encode("utf-8"))[0].decode().strip())
         # log.info(self.destinationDir)
         # log.info(stdout_data)
 
     def checkAndRun(self):
         """! Check if the source files have changed since the last run and run Doxygen if they have.
-        @details
+        @detailss
         @return: (bool) True if Doxygen was run.
         """
         if self.hasChanged():
@@ -175,7 +242,7 @@ def checkAndRun(self):
 
     def getOutputFolder(self) -> PurePath:
         """! Get the path to the XML output folder.
-        @details
+        @detailss
         @return: (PurePath) Path to the XML output folder.
         """
         return Path.joinpath(Path(self.tempDoxyFolder), Path("xml"))
@@ -184,3 +251,9 @@ def getOutputFolder(self) -> PurePath:
 # not valid path exception
 class DoxygenBinPathNotValid(Exception):
     pass
+
+class DoxygenCustomConfigNotFound(Exception):
+    pass
+
+class DoxygenCustomConfigNotValid(Exception):
+    pass
\ No newline at end of file
diff --git a/mkdoxy/generatorBase.py b/mkdoxy/generatorBase.py
index 07d4eded..4726a6f3 100644
--- a/mkdoxy/generatorBase.py
+++ b/mkdoxy/generatorBase.py
@@ -117,10 +117,13 @@ def error(
     ):
         """! Render an error page.
         @details
-        @param title (str): Title of the error page (default: "")
-        @param message (str): Message of the error page (default: "")
-        @param language (str): Programming language of the error page (default: "")
-        @return (str): Rendered error page.
+        @param config (dict): Config for the template.
+        @param title (str): Title of the error.
+        @param description (str): Description of the error.
+        @param code_header (str): Header of the code (default: "")
+        @param code (str): Code (default: "")
+        @param code_language (str): Language of the code (default: "")
+        @param snippet_code (str): Snippet code (default: "")
         """
         if config is None:
             config = {}
diff --git a/mkdoxy/plugin.py b/mkdoxy/plugin.py
index 64c8534f..97e58e9e 100644
--- a/mkdoxy/plugin.py
+++ b/mkdoxy/plugin.py
@@ -49,6 +49,7 @@ class MkDoxy(BasePlugin):
         ("debug", config_options.Type(bool, default=False)),
         # ('ignore-errors', config_options.Type(bool, default=False)),
         ("doxy-cfg", config_options.Type(dict, default={}, required=False)),
+        ("doxy-cfg-file", config_options.Type(str, default="", required=False)),
         ("template-dir", config_options.Type(str, default="", required=False)),
     )
 
@@ -119,6 +120,7 @@ def tempDir(siteDir: str, tempDir: str, projectName: str) -> str:
                 project_data.get("src-dirs"),
                 tempDirApi,
                 project_data.get("doxy-cfg", {}),
+                project_data.get("doxy-cfg-file", ""),
                 runPath,
             )
             if doxygenRun.checkAndRun():
diff --git a/tests/data/Doxyfile b/tests/data/Doxyfile
new file mode 100644
index 00000000..1fb9542e
--- /dev/null
+++ b/tests/data/Doxyfile
@@ -0,0 +1,7 @@
+DOXYFILE_ENCODING = UTF-8
+GENERATE_XML = YES
+RECURSIVE = YES
+EXAMPLE_PATH = examples
+SHOW_NAMESPACES = YES
+GENERATE_HTML = NO
+GENERATE_LATEX = NO
\ No newline at end of file
diff --git a/tests/test_doxyrun.py b/tests/test_doxyrun.py
new file mode 100644
index 00000000..e86f9d8e
--- /dev/null
+++ b/tests/test_doxyrun.py
@@ -0,0 +1,77 @@
+from mkdoxy.doxyrun import DoxygenRun
+def test_dox_dict2str():
+    dox_dict = {
+        "DOXYFILE_ENCODING": "UTF-8",
+        "GENERATE_XML": True,
+        "RECURSIVE": True,
+        "EXAMPLE_PATH": "examples",
+        "SHOW_NAMESPACES": True,
+        "GENERATE_HTML": False,
+        "GENERATE_LATEX": False,
+    }
+
+    doxygen_run = DoxygenRun(
+        doxygenBinPath="doxygen",
+        doxygenSource="/path/to/source/files",
+        tempDoxyFolder="/path/to/temp/folder",
+        doxyCfgNew=dox_dict,
+    )
+
+    result = doxygen_run.dox_dict2str(dox_dict)
+
+    expected_result = "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES\nRECURSIVE = YES\nEXAMPLE_PATH = examples\nSHOW_NAMESPACES = YES\nGENERATE_HTML = NO\nGENERATE_LATEX = NO"
+
+    assert result == expected_result
+
+#  Sets the Doxygen configuration using a custom config file
+def test_set_doxy_cfg_custom_file():
+    dox_dict = {}
+
+    doxygen_run = DoxygenRun(
+        doxygenBinPath="doxygen",
+        doxygenSource="/path/to/source/files",
+        tempDoxyFolder="/path/to/temp/folder",
+        doxyConfigFile="./tests/data/Doxyfile",
+        doxyCfgNew=dox_dict,
+    )
+
+    result = doxygen_run.setDoxyCfg(dox_dict)
+
+    expected_result = {
+        "DOXYFILE_ENCODING": "UTF-8",
+        "GENERATE_XML": True,
+        "RECURSIVE": True,
+        "EXAMPLE_PATH": "examples",
+        "SHOW_NAMESPACES": True,
+        "GENERATE_HTML": False,
+        "GENERATE_LATEX": False,
+        "INPUT": "/path/to/source/files",
+        "OUTPUT_DIRECTORY": "/path/to/temp/folder",
+    }
+
+    assert result == expected_result
+
+
+def test_str2dox_dict():
+    dox_str = "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES\nRECURSIVE = YES\nEXAMPLE_PATH = examples\nSHOW_NAMESPACES = YES\nGENERATE_HTML = NO\nGENERATE_LATEX = NO"
+
+    doxygen_run = DoxygenRun(
+        doxygenBinPath="doxygen",
+        doxygenSource="/path/to/source/files",
+        tempDoxyFolder="/path/to/temp/folder",
+        doxyCfgNew={},
+    )
+
+    result = doxygen_run.str2dox_dict(dox_str)
+
+    expected_result = {
+        "DOXYFILE_ENCODING": "UTF-8",
+        "GENERATE_XML": True,
+        "RECURSIVE": True,
+        "EXAMPLE_PATH": "examples",
+        "SHOW_NAMESPACES": True,
+        "GENERATE_HTML": False,
+        "GENERATE_LATEX": False,
+    }
+
+    assert result == expected_result
\ No newline at end of file

From 6cdeac4c03ae2bc0a1e8e4a13207ec3b7e16067e Mon Sep 17 00:00:00 2001
From: Jakub Andrysek <jakub.andrysek03@gmail.com>
Date: Wed, 3 Apr 2024 01:20:41 +0200
Subject: [PATCH 2/4] Lint + update tests

---
 .github/workflows/mkdoxy-test-demos.yaml |  2 +-
 .github/workflows/mkdoxy-test-repo.yaml  |  2 +-
 .idea/misc.xml                           |  2 +-
 .idea/workspace.xml                      | 17 ++++-------------
 demo-projects/animal/Doxyfile            |  2 +-
 docs/usage/advanced.md                   |  2 +-
 mkdoxy/doxyrun.py                        |  4 +++-
 setup.py                                 |  3 ++-
 tests/data/Doxyfile                      |  2 +-
 tests/test_doxyrun.py                    |  5 ++++-
 10 files changed, 19 insertions(+), 22 deletions(-)

diff --git a/.github/workflows/mkdoxy-test-demos.yaml b/.github/workflows/mkdoxy-test-demos.yaml
index e7df08ad..8d09ba83 100644
--- a/.github/workflows/mkdoxy-test-demos.yaml
+++ b/.github/workflows/mkdoxy-test-demos.yaml
@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest] # windows-latest, macos-latest requires doxygen to be installed manually
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v3
diff --git a/.github/workflows/mkdoxy-test-repo.yaml b/.github/workflows/mkdoxy-test-repo.yaml
index 81a93d27..c008dce6 100644
--- a/.github/workflows/mkdoxy-test-repo.yaml
+++ b/.github/workflows/mkdoxy-test-repo.yaml
@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest] # windows-latest, macos-latest requires doxygen to be installed manually
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v3
diff --git a/.idea/misc.xml b/.idea/misc.xml
index a6218fed..a0641c7e 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -4,4 +4,4 @@
     <option name="sdkName" value="Python 3.11" />
   </component>
   <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.11" project-jdk-type="Python SDK" />
-</project>
\ No newline at end of file
+</project>
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index c759aebb..bd58b38f 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -5,16 +5,7 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="5a348fe7-ee21-4e06-b8fc-ced5d548a610" name="Changes" comment="Upgrade version">
-      <change afterPath="$PROJECT_DIR$/demo-projects/animal/Doxyfile" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/tests/data/Doxyfile" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/tests/test_doxyrun.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/docs/usage/advanced.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/usage/advanced.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/mkdocs.yml" beforeDir="false" afterPath="$PROJECT_DIR$/mkdocs.yml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/mkdoxy/doxyrun.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/doxyrun.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/mkdoxy/generatorBase.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/generatorBase.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/mkdoxy/plugin.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/plugin.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/setup.py" beforeDir="false" afterPath="$PROJECT_DIR$/setup.py" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -69,7 +60,7 @@
     "RunOnceActivity.ShowReadmeOnStart": "true",
     "SHARE_PROJECT_CONFIGURATION_FILES": "true",
     "WebServerToolWindowFactoryState": "false",
-    "git-widget-placeholder": "main",
+    "git-widget-placeholder": "doxygen-config-file",
     "last_opened_file_path": "/Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-main/tests/data",
     "node.js.detected.package.eslint": "true",
     "node.js.detected.package.tslint": "true",
@@ -324,7 +315,7 @@
       <workItem from="1689697868617" duration="13000" />
       <workItem from="1689777262215" duration="704000" />
       <workItem from="1689947020589" duration="1060000" />
-      <workItem from="1712098386110" duration="1058000" />
+      <workItem from="1712098386110" duration="1331000" />
     </task>
     <task id="LOCAL-00001" summary="Optimise code by sourcery.ai">
       <created>1674630349699</created>
@@ -640,4 +631,4 @@
     <SUITE FILE_PATH="coverage/mkdoxy_main$pytest_in__.coverage" NAME="pytest in / Coverage Results" MODIFIED="1712098709702" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
     <SUITE FILE_PATH="coverage/mkdoxy_main$mkdocs_serve_vPy3_11.coverage" NAME="mkdocs-serve-vPy3.11 Coverage Results" MODIFIED="1712099288194" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
   </component>
-</project>
\ No newline at end of file
+</project>
diff --git a/demo-projects/animal/Doxyfile b/demo-projects/animal/Doxyfile
index 20dc954b..f8cc2640 100644
--- a/demo-projects/animal/Doxyfile
+++ b/demo-projects/animal/Doxyfile
@@ -4,4 +4,4 @@ RECURSIVE = YES
 EXAMPLE_PATH = examples
 SHOW_NAMESPACES = YES
 GENERATE_HTML = NO
-GENERATE_LATEX = YES
\ No newline at end of file
+GENERATE_LATEX = YES
diff --git a/docs/usage/advanced.md b/docs/usage/advanced.md
index a5dd5cb6..d4ec5a71 100644
--- a/docs/usage/advanced.md
+++ b/docs/usage/advanced.md
@@ -48,4 +48,4 @@ plugins:
           doxy-cfg-file: path/to/Doxyfile  # relative path to the Doxygen configuration file (relative to the mkdocs.yml file)
           doxy-cfg:       # standard doxygen configuration (key: value)
             FILE_PATTERNS: ... # other configuration options - merge (this will override the configuration from the Doxyfile)
-```
\ No newline at end of file
+```
diff --git a/mkdoxy/doxyrun.py b/mkdoxy/doxyrun.py
index ef901857..428a1919 100644
--- a/mkdoxy/doxyrun.py
+++ b/mkdoxy/doxyrun.py
@@ -252,8 +252,10 @@ def getOutputFolder(self) -> PurePath:
 class DoxygenBinPathNotValid(Exception):
     pass
 
+
 class DoxygenCustomConfigNotFound(Exception):
     pass
 
+
 class DoxygenCustomConfigNotValid(Exception):
-    pass
\ No newline at end of file
+    pass
diff --git a/setup.py b/setup.py
index 945e8a06..d8b3353b 100755
--- a/setup.py
+++ b/setup.py
@@ -33,12 +33,13 @@ def requirements():
     install_requires=["mkdocs"],
     extras_require={
         "dev": [
-            "mkdocs-material==9.1.18",
+            "mkdocs-material~=9.1.18",
             "Jinja2~=3.1.2",
             "mkdocs-open-in-new-tab~=1.0.2",
             "pathlib~=1.0.1",
             "path~=16.7.1",
             "isort~=5.12.0",
+            "pytest~=6.2.5",
         ],
     },
     classifiers=[
diff --git a/tests/data/Doxyfile b/tests/data/Doxyfile
index 1fb9542e..ac135f69 100644
--- a/tests/data/Doxyfile
+++ b/tests/data/Doxyfile
@@ -4,4 +4,4 @@ RECURSIVE = YES
 EXAMPLE_PATH = examples
 SHOW_NAMESPACES = YES
 GENERATE_HTML = NO
-GENERATE_LATEX = NO
\ No newline at end of file
+GENERATE_LATEX = NO
diff --git a/tests/test_doxyrun.py b/tests/test_doxyrun.py
index e86f9d8e..3a88c5be 100644
--- a/tests/test_doxyrun.py
+++ b/tests/test_doxyrun.py
@@ -1,4 +1,6 @@
 from mkdoxy.doxyrun import DoxygenRun
+
+
 def test_dox_dict2str():
     dox_dict = {
         "DOXYFILE_ENCODING": "UTF-8",
@@ -23,6 +25,7 @@ def test_dox_dict2str():
 
     assert result == expected_result
 
+
 #  Sets the Doxygen configuration using a custom config file
 def test_set_doxy_cfg_custom_file():
     dox_dict = {}
@@ -74,4 +77,4 @@ def test_str2dox_dict():
         "GENERATE_LATEX": False,
     }
 
-    assert result == expected_result
\ No newline at end of file
+    assert result == expected_result

From 2742273a26fd28137a447799768dd184b0f68e1d Mon Sep 17 00:00:00 2001
From: Jakub Andrysek <jakub.andrysek03@gmail.com>
Date: Wed, 3 Apr 2024 01:25:15 +0200
Subject: [PATCH 3/4] Add MkDoxy build workflow for all supported Python
 versions

---
 .github/workflows/mkdoxy-pytest-repo.yaml | 28 +++++++++++
 .idea/workspace.xml                       | 58 ++++++++++++-----------
 mkdoxy/doxyrun.py                         |  3 +-
 tests/test_doxyrun.py                     | 13 ++++-
 4 files changed, 71 insertions(+), 31 deletions(-)
 create mode 100644 .github/workflows/mkdoxy-pytest-repo.yaml

diff --git a/.github/workflows/mkdoxy-pytest-repo.yaml b/.github/workflows/mkdoxy-pytest-repo.yaml
new file mode 100644
index 00000000..50b1bf42
--- /dev/null
+++ b/.github/workflows/mkdoxy-pytest-repo.yaml
@@ -0,0 +1,28 @@
+name: MkDoxy build all supported Python versions
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest] # windows-latest, macos-latest requires doxygen to be installed manually
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+          sudo apt-get install doxygen
+      - name: Run Pytest
+        run: |
+          pytest tests/
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index bd58b38f..7036b79d 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -5,7 +5,9 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="5a348fe7-ee21-4e06-b8fc-ced5d548a610" name="Changes" comment="Upgrade version">
-      <change beforePath="$PROJECT_DIR$/setup.py" beforeDir="false" afterPath="$PROJECT_DIR$/setup.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/mkdoxy/doxyrun.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/doxyrun.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/tests/test_doxyrun.py" beforeDir="false" afterPath="$PROJECT_DIR$/tests/test_doxyrun.py" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -41,9 +43,9 @@
   <component name="MarkdownSettingsMigration">
     <option name="stateVersion" value="1" />
   </component>
-  <component name="ProjectColorInfo"><![CDATA[{
-  "associatedIndex": 3
-}]]></component>
+  <component name="ProjectColorInfo">{
+  &quot;associatedIndex&quot;: 3
+}</component>
   <component name="ProjectId" id="20sSF9RtRyYPthPvI9bA0t9QgTh" />
   <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
   <component name="ProjectViewState">
@@ -51,26 +53,26 @@
     <option name="hideEmptyMiddlePackages" value="true" />
     <option name="showLibraryContents" value="true" />
   </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "Python tests.pytest in /.executor": "Run",
-    "Python.mkdocs-serve-vPy3.11.executor": "Run",
-    "Python.mkdoxy-demo-vPy3.11.executor": "Debug",
-    "RunOnceActivity.OpenProjectViewOnStart": "true",
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "SHARE_PROJECT_CONFIGURATION_FILES": "true",
-    "WebServerToolWindowFactoryState": "false",
-    "git-widget-placeholder": "doxygen-config-file",
-    "last_opened_file_path": "/Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-main/tests/data",
-    "node.js.detected.package.eslint": "true",
-    "node.js.detected.package.tslint": "true",
-    "node.js.selected.package.eslint": "(autodetect)",
-    "node.js.selected.package.tslint": "(autodetect)",
-    "nodejs_package_manager_path": "npm",
-    "settings.editor.selected.configurable": "reference.settings.ide.settings.new.ui",
-    "vue.rearranger.settings.migration": "true"
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;Python tests.pytest in /.executor&quot;: &quot;Run&quot;,
+    &quot;Python.mkdocs-serve-vPy3.11.executor&quot;: &quot;Run&quot;,
+    &quot;Python.mkdoxy-demo-vPy3.11.executor&quot;: &quot;Debug&quot;,
+    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;SHARE_PROJECT_CONFIGURATION_FILES&quot;: &quot;true&quot;,
+    &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
+    &quot;git-widget-placeholder&quot;: &quot;doxygen-config-file&quot;,
+    &quot;last_opened_file_path&quot;: &quot;/Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-main/tests/data&quot;,
+    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
+    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
+    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
+    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
+    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
+    &quot;settings.editor.selected.configurable&quot;: &quot;reference.settings.ide.settings.new.ui&quot;,
+    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
   }
-}]]></component>
+}</component>
   <component name="RecentsManager">
     <key name="CopyFile.RECENT_KEYS">
       <recent name="$PROJECT_DIR$/tests/data" />
@@ -315,7 +317,7 @@
       <workItem from="1689697868617" duration="13000" />
       <workItem from="1689777262215" duration="704000" />
       <workItem from="1689947020589" duration="1060000" />
-      <workItem from="1712098386110" duration="1331000" />
+      <workItem from="1712098386110" duration="1897000" />
     </task>
     <task id="LOCAL-00001" summary="Optimise code by sourcery.ai">
       <created>1674630349699</created>
@@ -589,17 +591,17 @@
         </line-breakpoint>
         <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
           <url>file://$PROJECT_DIR$/mkdoxy/doxyrun.py</url>
-          <line>93</line>
+          <line>94</line>
           <option name="timeStamp" value="101" />
         </line-breakpoint>
         <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
           <url>file://$PROJECT_DIR$/mkdoxy/doxyrun.py</url>
-          <line>110</line>
+          <line>111</line>
           <option name="timeStamp" value="102" />
         </line-breakpoint>
         <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
           <url>file://$PROJECT_DIR$/tests/test_doxyrun.py</url>
-          <line>12</line>
+          <line>14</line>
           <option name="timeStamp" value="103" />
         </line-breakpoint>
         <line-breakpoint enabled="true" type="jinja2-line">
@@ -631,4 +633,4 @@
     <SUITE FILE_PATH="coverage/mkdoxy_main$pytest_in__.coverage" NAME="pytest in / Coverage Results" MODIFIED="1712098709702" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
     <SUITE FILE_PATH="coverage/mkdoxy_main$mkdocs_serve_vPy3_11.coverage" NAME="mkdocs-serve-vPy3.11 Coverage Results" MODIFIED="1712099288194" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
   </component>
-</project>
+</project>
\ No newline at end of file
diff --git a/mkdoxy/doxyrun.py b/mkdoxy/doxyrun.py
index 428a1919..b8e6f9ef 100644
--- a/mkdoxy/doxyrun.py
+++ b/mkdoxy/doxyrun.py
@@ -82,7 +82,8 @@ def setDoxyCfg(self, doxyCfgNew: dict) -> dict:
         @details - SHOW_NAMESPACES: YES
         @details - GENERATE_HTML: NO
         @details - GENERATE_LATEX: NO
-        @param doxyCfgNew: (dict) New Doxygen config options that will be added to the default config (new options will overwrite default options)
+        @param doxyCfgNew: (dict) New Doxygen config options that will be
+         added to the default config (new options will overwrite default options)
         @return: (dict) Doxygen configuration.
         """
         doxyCfg = {}
diff --git a/tests/test_doxyrun.py b/tests/test_doxyrun.py
index 3a88c5be..2c8cbff9 100644
--- a/tests/test_doxyrun.py
+++ b/tests/test_doxyrun.py
@@ -21,7 +21,12 @@ def test_dox_dict2str():
 
     result = doxygen_run.dox_dict2str(dox_dict)
 
-    expected_result = "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES\nRECURSIVE = YES\nEXAMPLE_PATH = examples\nSHOW_NAMESPACES = YES\nGENERATE_HTML = NO\nGENERATE_LATEX = NO"
+    expected_result = (
+        "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES"
+        "\nRECURSIVE = YES\nEXAMPLE_PATH = examples"
+        "\nSHOW_NAMESPACES = YES\nGENERATE_HTML = NO"
+        "\nGENERATE_LATEX = NO"
+    )
 
     assert result == expected_result
 
@@ -56,7 +61,11 @@ def test_set_doxy_cfg_custom_file():
 
 
 def test_str2dox_dict():
-    dox_str = "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES\nRECURSIVE = YES\nEXAMPLE_PATH = examples\nSHOW_NAMESPACES = YES\nGENERATE_HTML = NO\nGENERATE_LATEX = NO"
+    dox_str = (
+        "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES\n"
+        "RECURSIVE = YES\nEXAMPLE_PATH = examples\n"
+        "SHOW_NAMESPACES = YES\nGENERATE_HTML = NO\nGENERATE_LATEX = NO"
+    )
 
     doxygen_run = DoxygenRun(
         doxygenBinPath="doxygen",

From 0f1199a3b8c5f4fb1a9ea7d2d1f6afa6681e685b Mon Sep 17 00:00:00 2001
From: Jakub Andrysek <jakub.andrysek03@gmail.com>
Date: Wed, 3 Apr 2024 01:32:38 +0200
Subject: [PATCH 4/4] Add pre-commit package to setup.py

---
 .github/workflows/mkdoxy-pytest-repo.yaml | 2 +-
 .idea/workspace.xml                       | 2 +-
 setup.py                                  | 1 +
 3 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/mkdoxy-pytest-repo.yaml b/.github/workflows/mkdoxy-pytest-repo.yaml
index 50b1bf42..88a290f1 100644
--- a/.github/workflows/mkdoxy-pytest-repo.yaml
+++ b/.github/workflows/mkdoxy-pytest-repo.yaml
@@ -1,4 +1,4 @@
-name: MkDoxy build all supported Python versions
+name: MkDoxy Pytest MkDoxy with all supported Python versions
 
 on: [push, pull_request]
 
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 7036b79d..a37e08bd 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -633,4 +633,4 @@
     <SUITE FILE_PATH="coverage/mkdoxy_main$pytest_in__.coverage" NAME="pytest in / Coverage Results" MODIFIED="1712098709702" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
     <SUITE FILE_PATH="coverage/mkdoxy_main$mkdocs_serve_vPy3_11.coverage" NAME="mkdocs-serve-vPy3.11 Coverage Results" MODIFIED="1712099288194" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
   </component>
-</project>
\ No newline at end of file
+</project>
diff --git a/setup.py b/setup.py
index d8b3353b..4e8dc004 100755
--- a/setup.py
+++ b/setup.py
@@ -40,6 +40,7 @@ def requirements():
             "path~=16.7.1",
             "isort~=5.12.0",
             "pytest~=6.2.5",
+            "pre-commit~=3.7.0",
         ],
     },
     classifiers=[