From a5f6571cfbe15db5fc496256583934a5bbf1ceff Mon Sep 17 00:00:00 2001
From: Daria Fokina <daria.fokina@deepset.ai>
Date: Fri, 12 Apr 2024 12:51:39 +0200
Subject: [PATCH] docs: add evaluators component reference (#7532)

---
 docs/pydoc/config/evaluators_api.yml | 38 ++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 docs/pydoc/config/evaluators_api.yml

diff --git a/docs/pydoc/config/evaluators_api.yml b/docs/pydoc/config/evaluators_api.yml
new file mode 100644
index 0000000000..9acd64efb7
--- /dev/null
+++ b/docs/pydoc/config/evaluators_api.yml
@@ -0,0 +1,38 @@
+loaders:
+  - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+    search_path: [../../../haystack/components/evaluators]
+    modules:
+      [
+        "answer_exact_match",
+        "document_map",
+        "document_mrr",
+        "document_recall",
+        "evaluation_result",
+        "document_recall",
+        "faithfulness",
+        "llm_evaluator",
+        "sas_evaluator",
+      ]
+    ignore_when_discovered: ["__init__"]
+processors:
+  - type: filter
+    expression:
+    documented_only: true
+    do_not_filter_modules: false
+    skip_empty_modules: true
+  - type: smart
+  - type: crossref
+renderer:
+  type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+  excerpt: Evaluate your pipelines or individual components.
+  category_slug: haystack-api
+  title: Evaluators
+  slug: evaluators-api
+  order: 5
+  markdown:
+    descriptive_class_title: false
+    classdef_code_block: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: evaluators_api.md