adding api documentation for udf decorator

logicalclocks · Jun 17, 2024 · e722cc0 · e722cc0
1 parent f9db545
commit e722cc0
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/auto_doc.py b/auto_doc.py
@@ -27,6 +27,9 @@
         "mr_api": ["hopsworks.project.Project.get_model_registry"],
         "ms_api": ["hopsworks.project.Project.get_model_serving"],
     },
+    "api/udf.md": {
+        "udf": ["hopsworks.udf"],
+    },
     "api/connection.md": {
         "connection_create": ["hopsworks.connection.Connection.connection"],
         "connection_properties": keras_autodoc.get_properties(

diff --git a/docs/templates/api/udf.md b/docs/templates/api/udf.md
@@ -0,0 +1,3 @@
+# UDF API
+
+{{udf}}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -21,6 +21,7 @@ nav:
       - Login: generated/api/login.md
       - Connection: generated/api/connection.md
       - Projects: generated/api/projects.md
+      - UDF: generated/api/udf.md
       - Jobs: generated/api/jobs.md
       - Executions: generated/api/executions.md
       - FlinkCluster: generated/api/flink_cluster.md