custom extension does not reliably fix ref warnings

Author: rmorshea

docs/source/_exts/only_warn_on_broken_internal_refs.py

@@ -65,7 +65,6 @@
     "patched_html_translator",
     "widget_example",
     "build_custom_js",
-    "only_warn_on_broken_internal_refs",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/conf.py

@@ -58,6 +58,8 @@ def docs(session: Session) -> None:
         "python",
         "scripts/live_docs.py",
         "--open-browser",
+        # watch python source too
+        "--watch=src/idom",
         # for some reason this matches absolute paths
         "--ignore=**/auto/*",
         "--ignore=**/_static/custom.js",

noxfile.py

@@ -5,6 +5,7 @@
 
 from __future__ import annotations
 
+import inspect
 import logging
 from typing import Any, Iterable, List, Mapping, Optional, Sequence, Tuple, Union
 
@@ -197,13 +198,16 @@ def constructor(
             raise TypeError(f"{tag!r} nodes cannot have children.")
         return model
 
-    constructor.__name__ = tag
-    qualname_prefix = constructor.__qualname__.rsplit(".", 1)[0]
-    constructor.__qualname__ = qualname_prefix + f".{tag}"
-    constructor.__doc__ = (
-        f"""Create a new ``<{tag}/>`` - returns a :class:`VdomDict`."""
-    )
+    module = _get_module_name_by_frame_index(1)
+    if module is None:
+        qualname = None
+    else:
+        qualname = module + "." + tag
 
+    constructor.__name__ = tag
+    constructor.__module__ = module
+    constructor.__qualname__ = qualname
+    constructor.__doc__ = f"Return a new ``<{tag}/>`` :class:`VdomDict` element"
     return constructor
 
 
@@ -271,3 +275,13 @@ def _is_single_child(value: Any) -> bool:
                     logger.error(f"Key not specified for dynamic child {child}")
 
         return False
+
+
+def _get_module_name_by_frame_index(index: int) -> Optional[str]:
+    frame = inspect.currentframe()
+    for i in range(index + 1):  # add one to ignore this frame
+        if frame is None:
+            return None
+        else:
+            frame = frame.f_back
+    return frame.f_globals.get("__name__")

src/idom/core/vdom.py

@@ -6,7 +6,7 @@
 External sources
 ----------------
 
-link = make_vdom_constructor("link", allow_children=False)
+- :func:`link`
 
 
 Content Sectioning