Add generated API docs to documentation.

Author: adamghill

django_unicorn/views/__init__.py

@@ -519,12 +519,12 @@ def message(request: HttpRequest, component_name: Optional[str] = None) -> JsonR
     Returns:
         `JsonRequest` with the following structure in the body:
         {
-            "id": component_id,
-            "dom": html,  // re-rendered version of the component after actions in the payload are completed
-            "data": {},  // updated data after actions in the payload are completed
-            "errors": {},  // form validation errors
-            "return": {}, // optional return value from an executed action
-            "parent": {},  // optional representation of the parent component
+        "id": component_id,
+        "dom": html,  # re-rendered version of the component after actions in the payload are completed
+        "data": {},  # updated data after actions in the payload are completed
+        "errors": {},  # form validation errors
+        "return": {}, # optional return value from an executed action
+        "parent": {}  # optional representation of the parent component
         }
     """
 

django_unicorn/views/action_parsers/call_method.py

@@ -12,7 +12,6 @@
 from django_unicorn.utils import cast_value, get_method_arguments, get_type_hints
 from django_unicorn.views.action_parsers.utils import set_property_value
 from django_unicorn.views.objects import ComponentRequest, Return
-from django_unicorn.views.utils import set_property_from_data
 
 try:
     from typing import get_origin
@@ -24,6 +23,9 @@ def get_origin(type_hint):
 
 
 def handle(component_request: ComponentRequest, component: UnicornView, payload: Dict):
+    # Import here to prevent cyclic import
+    from django_unicorn.views.utils import set_property_from_data
+
     call_method_name = payload.get("name", "")
     if not call_method_name:
         raise AssertionError("Missing 'name' key for callMethod")

docs/source/conf.py

@@ -16,7 +16,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "Unicorn"
-copyright = "2021, Adam Hill"  # noqa: A001
+copyright = "2023, Adam Hill"  # noqa: A001
 author = "Adam Hill"
 
 pyproject = toml.load("../../pyproject.toml")
@@ -32,14 +32,14 @@
 extensions = [
     "sphinx.ext.duration",
     "sphinx.ext.doctest",
-    "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "myst_parser",
     "sphinx_copybutton",
     "sphinx.ext.napoleon",
     "sphinx.ext.autosectionlabel",
     "rst2pdf.pdfbuilder",
+    "autoapi.extension",
 ]
 
 intersphinx_mapping = {
@@ -79,3 +79,31 @@
 pdf_documents = [
     ("index", "unicorn-latest", "Unicorn", "Adam Hill"),
 ]
+
+autoapi_dirs = [
+    "../../django_unicorn",
+]
+autoapi_root = "api"
+autoapi_add_toctree_entry = False
+autoapi_generate_api_docs = True
+# autoapi_keep_files = True  # useful for debugging generated errors
+autoapi_options = [
+    "members",
+    "undoc-members",
+    "show-inheritance",
+]
+autoapi_type = "python"
+autodoc_typehints = "signature"
+
+
+def skip_member(app, what, name, obj, skip, options):  # noqa: ARG001
+    if what == "data" and name.endswith(".logger"):
+        skip = True
+    elif "startunicorn" in name:
+        skip = True
+
+    return skip
+
+
+def setup(sphinx):
+    sphinx.connect("autoapi-skip-member", skip_member)

docs/source/index.md

@@ -72,6 +72,14 @@ Code repo <https://github.com/adamghill/django-unicorn>
 Sponsor <https://github.com/sponsors/adamghill>
 ```
 
+```{toctree}
+:caption: API
+:maxdepth: 3
+:hidden:
+
+api/django_unicorn/index
+```
+
 Want to add some component-based magic to your front-end, but don't need the overhead of a complete JavaScript front-end framework? `Unicorn` revolutionizes the way your users interact with your Django app! With `Unicorn`, you can create stunningly spiffy pages without ever leaving Python or your beloved Django codebase.
 
 `Unicorn` is a reactive component framework that enhances your Django views by seamlessly making AJAX calls in the background and dynamically updates the HTML DOM. It's like magic, but better! `Unicorn` is leading the charge in bringing a component-based developer experience to Django. Join the `Unicorn` community today and unlock the power of reactivity!