update

Author: SilverRainZ

docs/conf.py

@@ -50,7 +50,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'furo'
+# html_theme = 'furo'
 
 html_theme_options = {}
 
@@ -121,3 +121,5 @@
 extensions.append('data')
 
 # CUSTOM CONFIGURATION
+
+keep_warnings = True

docs/index.rst

@@ -5,37 +5,11 @@
 sphinxnotes-data
 ================
 
-.. data:tmpl::
-   :on: parsed
-   :debug:
-
-   Name: {{ name }}
-
-   {% for k, v in attrs.items() %}
-   :{{ k }}: {{ v }}
-   {%- endfor %}
-
-   Content::
-
-      {{ content }}
-
-.. data:schema:: int
-   :color: bool, required
-   :size: int, required
-
-   lines of int
-
-123
-===
+FooBar
+======
 
-.. data:def::
+.. data:autodef::
    :color:
    :size: 1
 
-12a
-
-
-123555
-======
-
-zzzz
+Here2.

src/sphinxnotes/data/__init__.py

@@ -8,7 +8,6 @@
 
 from __future__ import annotations
 from typing import cast
-from textwrap import dedent
 
 from docutils import nodes
 from docutils.parsers.rst import directives
@@ -26,34 +25,9 @@
 
 logger = logging.getLogger(__name__)
 
-DEFAULT_TEMPLATE = Template(
-    debug=True,
-    phase=Phase.Parsing,
-    text=dedent("""
-    .. note::
-
-       This is a default template for rendering the data your deinfed.
-       Please create your own template using the :rst:dir:`data:tmpl` directive.
-
-   :Name: ``{{ name }}``
-   {% for k, v in attrs.items() %}
-   :{{ k }}: ``{{ v }}``
-   {%- endfor %}
-   :content: ::
-
-      {{ content }}"""),
-)
-
-DEFAULT_SCHEMA = Schema(
-    name=Field(),
-    attrs=Field(),
-    content=Field(),
-)
-
 TEMPLATE_KEY = 'sphinxnotes:template'
 SCHEMA_KEY = 'sphinxnotes:data'
 
-
 class DataNode(nodes.Node):
     data: Data
     template: Template
@@ -102,7 +76,7 @@ def _complete_external_data(self):
             if title := find_titular_node_upward(self.parent):
                 self.data.name = title.astext()
 
-        if not self.data.content:
+        if not self.data.content and self.parent:
             contnodes = []
             for i, child in enumerate(self.parent):
                 if child == self:
@@ -159,11 +133,11 @@ def _extract_data(self) -> Data:
         )
 
     def current_template(self) -> Template:
-        tmpl = self.env.current_document.get(TEMPLATE_KEY, DEFAULT_TEMPLATE)
+        tmpl = self.env.current_document.get(TEMPLATE_KEY, Template.default())
         return cast(Template, tmpl)
 
     def current_schema(self) -> Schema:
-        schema = self.env.current_document.get(SCHEMA_KEY, DEFAULT_SCHEMA)
+        schema = self.env.current_document.get(SCHEMA_KEY, Schema.default())
         return cast(Schema, schema)
 
     def new_pending_node(self) -> pending_data_node:

src/sphinxnotes/data/data.py

@@ -222,6 +222,11 @@ class Schema(object):
     attrs: dict[str, Field] | Field
     content: Field | None
 
+    @staticmethod
+    def default() -> Schema:
+        return Schema(name=Field(), attrs=Field(), content=Field())
+
+
     def _parse_single(
         self, field: tuple[str, Field | None], rawval: str | None
     ) -> Value:

src/sphinxnotes/data/render.py

@@ -82,9 +82,23 @@ class Template(object):
     phase: Phase
     debug: bool
 
-    @classmethod
-    def default(cls) -> Template:
-        return Template('THIS IS A DEFAULT TEMPLATE', Phase.default(), False)
+    @staticmethod
+    def default() -> Template:
+        return Template(debug=True,phase=Phase.Parsing, text="""
+.. note::
+
+   This is a default template for rendering the data your deinfed.
+   Please create your own template using the :rst:dir:`data:tmpl` directive.
+
+:Name: ``{{ name or 'None' }}``
+{% for k, v in attrs.items() %}
+:{{ k }}: ``{{ v or 'None' }}``
+{%- endfor %}
+:content:
+    ::
+
+        {{ content or 'None' }}""",
+    )
 
     def render(self, ctx: dict[str, Any]) -> str:
         return JinjaEnv().from_string(self.text).render(ctx)
@@ -104,18 +118,18 @@ def render(
 
     if tmpl.debug:
         sm = nodes.system_message(
-            'Template debug report:', type='WARNING', level=2, source=''
+            'template debug report:', type='DEBUG', level=2, source=''
         )
-        sm += _debug_report_part('data', pformat(data), lang='python')
+        sm += _debug_report_part('data:', pformat(data), lang='python')
         sm += _debug_report_part(
             f'template (phase: {tmpl.phase}, debug: {tmpl.debug}):',
             tmpl.text,
             lang='jinja',
         )
         sm += _debug_report_part(
-            'rendered node', '\n'.join(n.pformat() for n in ns), lang='xml'
+            'rendered nodes:', '\n'.join(n.pformat() for n in ns), lang='xml'
         )
-        ns += sm
+        ns.append(sm)
 
     return ns
 

src/sphinxnotes/data/utils.py

@@ -1,14 +1,11 @@
-from typing import TypeVar, Generic, get_args
-import dataclasses
+from typing import TypeVar, cast
 
 from docutils import nodes
 from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
 from docutils.utils import new_document
 from sphinx.util import logging
 
-from dacite import from_dict
-
 logger = logging.getLogger(__name__)
 
 
@@ -23,10 +20,10 @@ def parse_text_to_nodes(text: str) -> list[nodes.Node]:
     return document.children
 
 
-_Node = TypeVar('_Element', bound=nodes.Node)
+_Element = TypeVar('_Element', bound=nodes.Node)
 
 
-def find_parent(node: nodes.Element | None, typ: type[_Node]) -> _Node | None:
+def find_parent(node: nodes.Element | None, typ: type[_Element]) -> _Element | None:
     if node is None or isinstance(node, typ):
         return node
     return find_parent(node.parent, typ)
@@ -40,13 +37,13 @@ def find_current_document(node: nodes.Element | None) -> nodes.document | None:
     return find_parent(node, nodes.document)
 
 
-def find_first_child(node: nodes.Element, cls: type[_Node]) -> _Node | None:
+def find_first_child(node: nodes.Element, cls: type[_Element]) -> _Element | None:
     if (index := node.first_child_matching_class(cls)) is None:
         return None
-    return node[index]  # type: ignore
+    return cast(_Element, node[index])
 
 
-def find_titular_node_upward(node: nodes.Element | None) -> nodes.Node | None:
+def find_titular_node_upward(node: nodes.Element | None) -> nodes.Element | None:
     if node is None:
         return None
     if isinstance(node, (nodes.section, nodes.sidebar)):
@@ -62,52 +59,3 @@ def find_titular_node_upward(node: nodes.Element | None) -> nodes.Node | None:
         if para := find_first_child(node, nodes.paragraph):
             return para
     return find_titular_node_upward(node.parent)
-
-
-DataT = TypeVar('DataT')
-
-
-class TempData(Generic[DataT]):
-    """A helper class for storing/accessing dataclasses to/from a docutils node."""
-
-    KEY = 'sphinxnotes-data'
-
-    @classmethod
-    def _get_data_type(cls) -> type[DataT]:
-        """
-        Dynamically extract the actual type of DataT from the class definition.
-
-        Example: For `class MyHelper(TempData[MyStruct])`, this returns `MyStruct`.
-        """
-        # Access the original base classes (including generic type args)
-        # This attribute is available in Python 3.7+
-        for base in getattr(cls, '__orig_bases__', []):
-            origin = getattr(base, '__origin__', None)
-            # Check if this base is the TempData class itself
-            if origin is TempData:
-                args = get_args(base)
-                if args:
-                    # Return the first generic argument, which corresponds to DataT
-                    return args[0]
-        raise TypeError(
-            f'Cannot infer DataT from {cls.__name__}. '
-            'Ensure you are subclassing TempData[MyType] rather than using it directly.'
-        )
-
-    @classmethod
-    def _get_type_name(cls) -> str:
-        return cls._get_data_type().__name__
-
-    @classmethod
-    def set(cls, node: nodes.Element, data: DataT) -> None:
-        tempdata = node.setdefault(cls.KEY, {})
-        assert dataclasses.is_dataclass(data)
-        tempdata[cls._get_type_name()] = dataclasses.asdict(data)  # type: ignore
-
-    @classmethod
-    def get(cls, node: nodes.Element) -> DataT | None:
-        if (tempdata := node.get(cls.KEY)) is None:
-            return None
-        if (data := tempdata.get(cls._get_type_name())) is None:
-            return None
-        return from_dict(data_class=cls._get_data_type(), data=data)