chore: cleanup

phil65 · Nov 12, 2023 · a842a03 · a842a03
1 parent 8827ba7
commit a842a03
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 99 deletions.
diff --git a/docs/classpage_custom.jinja b/docs/classpage_custom.jinja
@@ -2,7 +2,7 @@
 {% block content %}
 
 {% if cls | hasattr("REQUIRED_EXTENSIONS") and cls.REQUIRED_EXTENSIONS %}
-#### Required Extensions:
+{{ "Required Extensions:" | MkHeader(level=4) }}
 
 {% for i in cls.REQUIRED_EXTENSIONS %}
 

diff --git a/mknodes/basenodes/mkannotations/metadata.toml b/mknodes/basenodes/mkannotations/metadata.toml
@@ -4,6 +4,23 @@ icon = "mdi:alert-box"
 
 [requirements.extension."pymdownx.superfences"]
 
+[examples.python]
+python = """
+import mknodes as mk
+
+page += mk.MkCode.for_object(mk.MkCode.for_object, extract_body=True)
+node = MkAnnotations()
+page += node
+text = mk.MkText("The MkAnnotations node aggregates annotations(1).")
+page += text
+info = r"Annotations are numbered and can be set via \\__setitem__."
+node[1] = info  # (1)
+admonition = mk.MkAdmonition("They can also contain other Markdown.")
+node[2] = admonition  # (2)
+text.annotations[1] = "Every MkNode can annotate via the 'annotations' attribute"
+page += mk.MkCode(str(node), language="markdown", header="Markdown")
+"""
+
 [fragments.annotation]
 template = """
 {{ node.num }}.{{ 3 - self.num | string | length }}{{ node.items | join("\n\n") | indent }}

diff --git a/mknodes/pages/mkclasspage/classpage.md b/mknodes/pages/mkclasspage/classpage.md
@@ -1,18 +1,18 @@
 {% block content %}
 
 {% if subclasses %}
-### Sub classes
+{{ "Sub classes" | MkHeader(level=3) }}
 {{ subclasses | MkClassTable }}
 {% endif %}
 
 {% if cls.mro() | length > 2 %}
-### Base classes
+{{ "Base classes" | MkHeader(level=3) }}
 {{ cls.__bases__ | MkClassTable }}
-### ⋔ Inheritance diagram
+{{ "⋔ Inheritance diagram" | MkHeader(level=3) }}
 {{ cls | MkClassDiagram(mode="baseclasses") }}
 {% endif %}
 
-### 🛈 DocStrings
+{{ "🛈 DocStrings" | MkHeader(level=3) }}
 
 {{ cls | MkDocStrings }}
 

diff --git a/mknodes/templatenodes/mkbadge/__init__.py b/mknodes/templatenodes/mkbadge/__init__.py
@@ -123,20 +123,12 @@ def data(self) -> str:
             use_gitlab_style=self.use_gitlab_style,
         )
 
-    @data.setter
-    def data(self, value):
-        pass
-
     @property
     def path(self) -> str:
         hashed = helpers.get_hash(repr(self))
         unique = f"{self.label}_{self.value}_{hashed}.svg"
         return helpers.slugify(unique)
 
-    @path.setter
-    def path(self, value):
-        pass
-
     @classmethod
     def create_example_page(cls, page):
         import mknodes as mk

diff --git a/mknodes/treelib/__init__.py b/mknodes/treelib/__init__.py
@@ -4,7 +4,6 @@
 
 from .node import Node
 from .filetreenode import FileTreeNode
-from .modulenode import ModuleNode
 from .noderesolver import NodeResolver
 
-__all__ = ["Node", "FileTreeNode", "ModuleNode", "NodeResolver"]
+__all__ = ["Node", "FileTreeNode", "NodeResolver"]
diff --git a/mknodes/treelib/modulenode.py b/mknodes/treelib/modulenode.py