From 704293d4915c789d323502bcd7cc84871f9dabb6 Mon Sep 17 00:00:00 2001
From: Stefano Fiorucci <stefanofiorucci@gmail.com>
Date: Fri, 26 Apr 2024 12:30:21 +0200
Subject: [PATCH] add pydoc config for evaluation (#7602)

---
 docs/pydoc/config/evaluation_api.yml | 30 ++++++++++++++++++++++++++++
 docs/pydoc/config/evaluators_api.yml |  3 +--
 2 files changed, 31 insertions(+), 2 deletions(-)
 create mode 100644 docs/pydoc/config/evaluation_api.yml

diff --git a/docs/pydoc/config/evaluation_api.yml b/docs/pydoc/config/evaluation_api.yml
new file mode 100644
index 0000000000..fe972c22a8
--- /dev/null
+++ b/docs/pydoc/config/evaluation_api.yml
@@ -0,0 +1,30 @@
+loaders:
+  - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+    search_path: [../../../haystack/evaluation]
+    modules:
+      [
+        "eval_run_result"
+      ]
+    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: Represents the results of evaluation.
+  category_slug: haystack-api
+  title: Evaluation
+  slug: evaluation-api
+  order: 61
+  markdown:
+    descriptive_class_title: false
+    classdef_code_block: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: evaluation_api.md
diff --git a/docs/pydoc/config/evaluators_api.yml b/docs/pydoc/config/evaluators_api.yml
index b24b3003e0..8c6ffe1556 100644
--- a/docs/pydoc/config/evaluators_api.yml
+++ b/docs/pydoc/config/evaluators_api.yml
@@ -8,7 +8,6 @@ loaders:
         "document_map",
         "document_mrr",
         "document_recall",
-        "evaluation_result",
         "document_recall",
         "faithfulness",
         "llm_evaluator",
@@ -29,7 +28,7 @@ renderer:
   category_slug: haystack-api
   title: Evaluators
   slug: evaluators-api
-  order: 5
+  order: 63
   markdown:
     descriptive_class_title: false
     classdef_code_block: false