Add basic support for diagrams and dot files generation

mkdocs.yml

@@ -24,10 +24,16 @@ theme:
  icon:
  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
 
 extra:
  social:
@@ -75,13 +81,25 @@ plugins:
  OPTIMIZE_OUTPUT_JAVA: True
  JAVADOC_AUTOBRIEF: True
  EXTRACT_ALL: True
+
+ GENERATE_HTML: YES
+ HAVE_DOT: YES
+ DOT_IMAGE_FORMAT: jpg
+ # HAVE_DOT: YES
+ UML_LOOK: YES
  animal:
  src-dirs: demo-projects/animal
  full-doc: True
  doxy-cfg:
  FILE_PATTERNS: "*.cpp *.h*"
  EXAMPLE_PATH: examples
  RECURSIVE: True
+ GENERATE_HTML: YES
+ HAVE_DOT: YES
+ # DOT_IMAGE_FORMAT: jpg
+ DOT_IMAGE_FORMAT: svg
+ # INTERACTIVE_SVG: YES
+ # UML_LOOK: YES
  save-api: .mkdoxy
  full-doc: True
  debug: False

mkdoxy/doxygen.py

@@ -1,5 +1,6 @@
 import logging
 import os
+from pathlib import PurePath
 from xml.etree import ElementTree
 
 from mkdoxy.cache import Cache
@@ -12,7 +13,7 @@
 
 
 class Doxygen:
- def __init__(self, index_path: str, parser: XmlParser, cache: Cache):
+ def __init__(self, index_path: PurePath, parser: XmlParser, cache: Cache):
  self.debug = parser.debug
  path_xml = os.path.join(index_path, "index.xml")
  if self.debug:

mkdoxy/generatorAuto.py

@@ -64,6 +64,17 @@ def save(self, path: str, output: str):
  with open(os.path.join(self.tempDoxyDir, pathRel), "w", encoding="utf-8") as file:
  file.write(output)
 
+ def save_image(self, path: str, image_source_link: str):
+ # copy image from image_source_link to mkdocs
+ source = os.path.join(self.tempDoxyDir, "html", image_source_link)
+ if not os.path.exists(source):
+ return
+ destination = os.path.join(self.siteDir, self.apiPath, path, image_source_link)
+ os.makedirs(os.path.dirname(destination), exist_ok=True)
+ with open(source, "rb") as fsrc:
+ with open(destination, "wb") as fdst:
+ fdst.write(fsrc.read())
+
  def fullDoc(self, defaultTemplateConfig: dict):
  self.annotated(self.doxygen.root.children, defaultTemplateConfig)
  self.fileindex(self.doxygen.files.children, defaultTemplateConfig)
@@ -246,6 +257,14 @@ def hierarchy(self, nodes: [Node], config: dict = None):
 
  def member(self, node: Node, config: dict = None):
  path = node.filename
+ refid = node.refid
+
+ if node.has_inheritance_graph:
+ self.save_image(refid, node.inheritance_graph)
+ if node.has_collaboration_graph:
+ self.save_image(refid, node.collaboration_graph)
+ # if node.has_directory_dependency:
+ # self.save_image(refid, node.directory_dependency)
 
  output = self.generatorBase.member(node, config)
  self.save(path, output)

mkdoxy/generatorBase.py

@@ -6,6 +6,7 @@
 from jinja2 import BaseLoader, Environment, Template
 from jinja2.exceptions import TemplateError
 from mkdocs import exceptions
+from pprint import pformat
 
 import mkdoxy
 from mkdoxy.constants import Kind
@@ -106,10 +107,30 @@ def render(self, tmpl: Template, data: dict) -> str:
  @param data (dict): Data to render the template.
  @return (str): Rendered template.
  """
+
+ def print_node_content(node: Node, level=0, max_depth=1):
+ if level > max_depth:
+ return "" # Stop recursion when max depth is exceeded
+
+ indent = "\n" + " " * (level * 4) + "- " # Indentation for better readability
+ # node_representation = f"{indent}Node at Level {level}: {pformat(vars(node))}\n"
+ node_representation = f"{indent}Node at Level {level}: {node.name}\n"
+ # print all attributes of the node
+ for key, value in vars(node).items():
+ if key == "children":
+ continue
+ node_representation += f"{indent} {key}: {pformat(value)}\n"
+
+ # Assuming each node has a list or iterable of child nodes in an attribute like `children`
+ for child in getattr(node, "children", []):
+ node_representation += print_node_content(child, level + 1, max_depth)
+
+ return node_representation
+
  try:
  # if self.debug:
  # print('Generating', path) # TODO: add path to data
- rendered: str = tmpl.render(data)
+ rendered: str = tmpl.render(data, pformat=pformat, vars=vars, print_node_content=print_node_content)
  return rendered
  except TemplateError as e:
  raise Exception(str(e)) from e

mkdoxy/node.py

@@ -87,6 +87,9 @@ def __init__(
  self._initializer = Property.Initializer(self._xml, parser, self._kind)
  self._definition = Property.Definition(self._xml, parser, self._kind)
  self._programlisting = Property.Programlisting(self._xml, parser, self._kind)
+ self._inheritancegraph = Property.InheritanceGraph(self._xml, parser, self._kind)
+ self._collaborationgraph = Property.CollaborationGraph(self._xml, parser, self._kind)
+ # self._directorydependency = Property.DirectoryDependency(self._xml, parser, self._kind)
 
  def __repr__(self):
  return f"Node: {self.name} refid: {self._refid}"
@@ -825,6 +828,30 @@ def has_programlisting(self) -> bool:
  def programlisting(self) -> str:
  return self._programlisting.md()
 
+ @property
+ def has_inheritance_graph(self) -> bool:
+ return self._inheritancegraph.has()
+
+ @property
+ def inheritance_graph(self) -> str:
+ return self._inheritancegraph.md()
+
+ @property
+ def has_collaboration_graph(self) -> bool:
+ return self._collaborationgraph.has()
+
+ @property
+ def collaboration_graph(self) -> str:
+ return self._collaborationgraph.md()
+
+ # @property
+ # def has_directory_dependency(self) -> bool:
+ # return self._directorydependency.has()
+ #
+ # @property
+ # def directory_dependency(self) -> str:
+ # return self._directorydependency.md()
+
  @property
  def is_resolved(self) -> bool:
  return True

mkdoxy/property.py

@@ -343,3 +343,52 @@ def md(self, plain: bool = False) -> str:
 
  def has(self) -> bool:
  return self.xml.find("programlisting") is not None
+
+ class InheritanceGraph:
+ def __init__(self, xml: Element, parser: XmlParser, kind: Kind):
+ self.xml = xml
+ self.parser = parser
+ self.kind = kind
+ self.refid = self.xml.attrib.get("id") if self.xml is not None else None
+
+ def md(self, plain: bool = False) -> str:
+ return f"{self.refid}__inherit__graph.svg"
+
+ def plain(self) -> str:
+ return self.md(plain=True)
+
+ def has(self) -> bool:
+ return self.kind.is_class() and self.refid is not None and self.xml.find("inheritancegraph") is not None
+
+ class CollaborationGraph:
+ def __init__(self, xml: Element, parser: XmlParser, kind: Kind):
+ self.xml = xml
+ self.parser = parser
+ self.kind = kind
+ self.refid = self.xml.attrib.get("id") if self.xml is not None else None
+
+ def md(self, plain: bool = False) -> str:
+ return f"{self.refid}__coll__graph.svg"
+
+ def plain(self) -> str:
+ return self.md(plain=True)
+
+ def has(self) -> bool:
+ return self.kind.is_class() and self.refid is not None and self.xml.find("collaborationgraph") is not None
+
+ # class DirectoryDependency:
+ # def __init__(self, xml: Element, parser: XmlParser, kind: Kind):
+ # self.xml = xml
+ # self.parser = parser
+ # self.kind = kind
+ # self.refid = self.xml.attrib.get("id") if self.xml is not None else None
+ #
+ # def md(self, plain: bool = False) -> str:
+ # return f"{self.refid}_dep.svg"
+ #
+ # def plain(self) -> str:
+ # return self.md(plain=True)
+ #
+ # def has(self) -> bool:
+ # return (self.refid is not None and
+ # (self.kind.is_dir()))

mkdoxy/templates/member.jinja2

@@ -5,6 +5,9 @@ implements: True
 ---
 {% filter indent(config.get('indent_level', 0), True) %}
 
+
+{#{{ print_node_content(node) }}#}
+
 # {{node.kind.value|title}} {{node.name_long}}
 {% if node.has_templateparams %}
 **template <{{node.templateparams}}>**
@@ -31,6 +34,31 @@ implements: True
 {% endfor -%}
 {%- endif %}
 
+
+{% if node.has_inheritance_graph %}
+### Inheritance diagram:
+{#{{ node.inheritance_graph }}#}
+<p align="center" markdown>
+ ![alt]({{ node.inheritance_graph }})
+</p>
+{% endif %}
+
+{% if node.has_collaboration_graph %}
+### Collaboration diagram:
+{#{{ node.collaboration_graph }}#}
+<p align="center" markdown>
+ ![alt]({{ node.collaboration_graph }})
+</p>
+{% endif %}
+
+{#{% if node.has_directory_dependency %}#}
+{#### Directory dependency graph:#}
+{#{{ node.directory_dependency }}#}
+{#<p align="center" markdown>#}
+{# ![alt]({{ node.directory_dependency }})#}
+{#</p>#}
+{#{% endif %}#}
+
 {% if node.has_base_classes %}
 Inherits the following classes:
 {%- for base in node.base_classes -%}