Update MkDoxy core to version 2.0

.github/workflows/mkdoxy-test-demos.yaml

@@ -24,7 +24,7 @@ jobs:
           python -m pip install -e ".[dev]"
           sudo apt-get install doxygen
       - name: Clone test repo
-        run: git clone https://github.com/JakubAndrysek/MkDoxy-demo.git demo
+        run: git clone --branch core-update https://github.com/JakubAndrysek/MkDoxy-demo.git demo
       - name: Build docs
         run: |
           cd demo

.gitignore

@@ -289,3 +289,5 @@ tests/files/.mkdoxy
 .mkdoxy/
 temp/
 local/
+
+.idea/

.pre-commit-config.yaml

@@ -1,16 +1,28 @@
 ---
 repos:
+  - repo: https://github.com/sourcery-ai/sourcery
+    rev: v1.19.0
+    hooks:
+      - id: sourcery
+        # The best way to use Sourcery in a pre-commit hook:
+        # * review only changed lines:
+        # * omit the summary
+        args: [--diff=git diff HEAD, --no-summary]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
   - repo: https://github.com/psf/black
     rev: 23.9.1
     hooks:
       - id: black
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.292'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.9.6
     hooks:
+      # Run the linter.
       - id: ruff
-        args: [--fix, --exit-non-zero-on-fix]
+        args: [ --fix, --exit-non-zero-on-fix ]
+      # Run the formatter.
+      - id: ruff-format

Makefile

@@ -3,28 +3,28 @@
 # Packaging
 package:
 	rm -f dist/*
-	python3 -m build --wheel  # Updated to use python3 build tool for wheel
-	python3 setup.py sdist
+	hatch build
 
 install: package
-	python3 -m pip install --no-deps --force dist/*.whl
+	hatch install
 
 release: package
-	twine upload --repository pypi dist/*
+	hatch publish
 
 release-test: package
-	twine upload --repository testpypi dist/*
+	hatch publish --index test
 
 clean:
 	rm -rf dist build
+	hatch clean
 
 
 # Testing
 reviewCode:
 	sourcery review mkdoxy --in-place
 
 install-dev:
-	python3 -m pip install --force --editable .
+	hatch env create
 
 # Documentation
 docs-serve:
@@ -35,3 +35,13 @@ docs-build: # results in site directory
 
 pre-commit:
 	pre-commit run --show-diff-on-failure --color=always --all-files
+
+# Linting
+lint:
+	ruff check mkdoxy
+
+format:
+	ruff format mkdoxy
+
+lint-fix:
+	ruff check --fix mkdoxy

README.md

@@ -41,6 +41,7 @@ pip install mkdoxy
 ```
 Development version with all dependencies:
 ```bash
+python -m venv .venv
 python -m pip install mkdoxy ".[dev]"
 ```
 

mkdocs.yml

@@ -25,9 +25,23 @@ theme:
     repo: fontawesome/brands/github
 
   palette:
-    - scheme: slate
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
       primary: orange
       accent: orange
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: orange
+      accent: orange
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
 
 extra:
   social:
@@ -64,29 +78,56 @@ plugins:
       enabled: !ENV [ENABLE_MKDOXY, True]
       projects:
         mkdoxyApi:
-          src-dirs: mkdoxy
-          full-doc: True
-          template-dir: templates-custom
-          doxy-cfg-file: demo-projects/animal/Doxyfile
-          doxy-cfg:
+          src_dirs: mkdoxy
+          full_doc: True
+          template_dir: templates-custom
+#          doxy_config_file: demo-projects/animal/Doxyfile
+          doxy_config_dict:
             FILE_PATTERNS: "*.py"
             EXAMPLE_PATH: ""
             RECURSIVE: True
             OPTIMIZE_OUTPUT_JAVA: True
             JAVADOC_AUTOBRIEF: True
             EXTRACT_ALL: True
         animal:
-          src-dirs: demo-projects/animal
-          full-doc: True
-          doxy-cfg:
+          src_dirs: demo-projects/animal
+          full_doc: True
+          doxy_config_dict:
             FILE_PATTERNS: "*.cpp *.h*"
             EXAMPLE_PATH: examples
             RECURSIVE: True
-      save-api: .mkdoxy
-      full-doc: True
+#      save_api: .mkdoxy
+      full_doc: True
       debug: False
-      ignore-errors: False
-      emojis-enabled: True
+      ignore_errors: False
+
+#  - mkdoxy:
+#      enabled: !ENV [ENABLE_MKDOXY, True]
+#      projects:
+#        mkdoxyApi:
+#          src-dirs: mkdoxy
+#          full-doc: True
+#          template-dir: templates-custom
+#          doxy-cfg-file: demo-projects/animal/Doxyfile
+#          doxy-cfg:
+#            FILE_PATTERNS: "*.py"
+#            EXAMPLE_PATH: ""
+#            RECURSIVE: True
+#            OPTIMIZE_OUTPUT_JAVA: True
+#            JAVADOC_AUTOBRIEF: True
+#            EXTRACT_ALL: True
+#        animal:
+#          src-dirs: demo-projects/animal
+#          full-doc: True
+#          doxy-cfg:
+#            FILE_PATTERNS: "*.cpp *.h*"
+#            EXAMPLE_PATH: examples
+#            RECURSIVE: True
+#      save-api: .mkdoxy
+#      full-doc: True
+#      debug: False
+#      ignore-errors: False
+#      emojis-enabled: True
 
 markdown_extensions:
   - pymdownx.highlight

mkdoxy/DoxyTagParser.py

@@ -2,63 +2,63 @@
 
 
 class DoxyTagParser:
-    def __init__(self, markdown_page: str, debug: bool = False):
+    def __init__(self, markdown_page: str, debug: bool = False) -> None:
         self.markdown_page = markdown_page
         self.debug = debug
         self.doxy_key = "::: doxy"
-        self.indent = "(?P<indent>[\t ]*)"
+        self.indent = "(?P<indent>[\\t ]*)"
         self.project = "(?P<project>[a-zA-Z]+)"
         self.key = "(?P<key>[a-zA-Z.-_]+)"
-        self.dot = "\."
+        self.dot = "\\."
         self.optional_dot = "[.]?"
-        self.look_ahead = "(?=\n)"  # it's a look ahead because we don't want to capture the newline
+        self.look_ahead = "(?=\\n)"  # it's a look ahead because we don't want to capture the newline
 
-    def replaceMarkdown(self, start: int, end: int, replace_format: str, **kwargs):
+    def replace_markdown(self, start: int, end: int, replace_format: str, **kwargs) -> None:
         self.markdown_page = self.markdown_page.replace(self.markdown_page[start:end], replace_format.format(**kwargs))
 
-    def returnMarkdown(self):
+    def return_markdown(self):
         return self.markdown_page
 
-    def parseEmptyTag(self, replacement: str):
+    def parse_empty_tag(self, replacement: str) -> None:
         empty_tag = (
             rf"{self.indent}{self.doxy_key}{self.optional_dot}{self.look_ahead}"  # https://regex101.com/r/Zh38uo/1
         )
         matches = re.finditer(empty_tag, self.markdown_page, re.MULTILINE)
         for match in reversed(list(matches)):
-            self.replaceMarkdown(match.start(), match.end(), replacement, indent=match.group("indent"))
+            self.replace_markdown(match.start(), match.end(), replacement, indent=match.group("indent"))
 
-    def parseProject(self, replacement: str):
+    def parse_project(self, replacement: str) -> None:
         project_tag = rf"{self.indent}{self.doxy_key}{self.dot}{self.project}{self.optional_dot}{self.look_ahead}"  # https://regex101.com/r/TfAsmE/1
         matches = re.finditer(project_tag, self.markdown_page, re.MULTILINE)
         for match in reversed(list(matches)):
-            self.replaceMarkdown(
+            self.replace_markdown(
                 match.start(),
                 match.end(),
                 replacement,
                 indent=match.group("indent"),
                 project=match.group("project"),
             )
 
-    def parseProjectTagSingle(self, replacement: str):
+    def parse_project_tag_single(self, replacement: str) -> None:
         project_tag = (
             rf"{self.indent}{self.doxy_key}{self.dot}{self.project}{self.dot}(?P<key>[a-zA-Z-_]+){self.look_ahead}"
         )
         matches = re.finditer(project_tag, self.markdown_page, re.MULTILINE)
         for match in reversed(list(matches)):
-            self.replaceMarkdown(
+            self.replace_markdown(
                 match.start(),
                 match.end(),
                 replacement,
                 project=match.group("project"),
                 key=match.group("key"),
             )
 
-    def parseProjectTagMulti(self, replacement: str):
-        project_tag = rf"{self.indent}{self.doxy_key}{self.dot}{self.project}{self.dot}(?P<key>[a-zA-Z-_]+)\s*\n(?:(?=\n)|(?=:::)|\Z)"  # noqa: E501
+    def parse_project_tag_multi(self, replacement: str) -> None:
+        project_tag = rf"{self.indent}{self.doxy_key}{self.dot}{self.project}{self.dot}(?P<key>[a-zA-Z-_]+)\\s*\\n(?:(?=\\n)|(?=:::)|\\Z)"  # noqa: E501
         matches = re.finditer(project_tag, self.markdown_page, re.MULTILINE)
         for match in reversed(list(matches)):
             list_keys = match.group("key").split(".")  # split keys by . to allow for nested keys
-            self.replaceMarkdown(
+            self.replace_markdown(
                 match.start(),
                 match.end(),
                 replacement,

mkdoxy/__main__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+from mkdoxy.cli import main
+
+if __name__ == "__main__":
+    main()

mkdoxy/cache.py

@@ -1,8 +1,8 @@
 class Cache:
-    def __init__(self):
+    def __init__(self) -> None:
         self.cache = {}
 
-    def add(self, key: str, value):
+    def add(self, key: str, value) -> None:
         self.cache[key] = value
 
     def get(self, key: str):