feat: add decorator for writing component tests (#1008)

* feat: add decorator for writing component tests

* refactor: udpate changelog + update deps pins

* refactor: fix deps

* refactor: make cached_ref into generic and fix linter errors

* refactor: fix coverage testing

* refactor: use global var instead of env var for is_testing state

docs/scripts/reference.py

@@ -108,6 +108,40 @@ def gen_reference_api():
             f.write("\n")
 
 
+def gen_reference_testing_api():
+    """
+    Generate documentation for the Python API of `django_components.testing`.
+
+    This takes all public symbols exported from `django_components.testing`.
+    """
+    module = import_module("django_components.testing")
+
+    preface = "<!-- Autogenerated by reference.py -->\n\n"
+    preface += (root / "docs/templates/reference_testing_api.md").read_text()
+    out_file = root / "docs/reference/testing_api.md"
+
+    out_file.parent.mkdir(parents=True, exist_ok=True)
+    with out_file.open("w", encoding="utf-8") as f:
+        f.write(preface + "\n\n")
+
+        for name, obj in inspect.getmembers(module):
+            if (
+                name.startswith("_")
+                or inspect.ismodule(obj)
+            ):
+                continue
+
+            # For each entry, generate a mkdocstrings entry, e.g.
+            # ```
+            # ::: django_components.testing.djc_test
+            #     options:
+            #       show_if_no_docstring: true
+            # ```
+            f.write(f"::: {module.__name__}.{name}\n" f"    options:\n" f"      show_if_no_docstring: true\n")
+
+            f.write("\n")
+
+
 def gen_reference_exceptions():
     """
     Generate documentation for the Exception classes included in the Python API of `django_components`.
@@ -739,6 +773,7 @@ def gen_reference():
     gen_reference_templatetags()
     gen_reference_templatevars()
     gen_reference_signals()
+    gen_reference_testing_api()
 
 
 # This is run when `gen-files` plugin is run in mkdocs.yml