docs: add Supercomponent pydoc, delete outdated (#193)

* supercomponent_pydoc * change folder
deepset-ai · Feb 11, 2025 · 6753f81 · 6753f81
1 parent c689c05
commit 6753f81
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 12 deletions.
diff --git a/docs/pydoc/config/document_stores_api.yml b/docs/pydoc/config/document_stores_api.yml
@@ -22,7 +22,7 @@ renderer:
   category_slug: experiments-api
   title: Document Stores
   slug: experimental-document-stores-api
-  order: 160
+  order: 10
   markdown:
     descriptive_class_title: false
     classdef_code_block: false

diff --git a/docs/pydoc/config/evaluation_harness_api.yml b/docs/pydoc/config/evaluation_harness_api.yml
@@ -19,7 +19,7 @@ renderer:
   category_slug: experiments-api
   title: Evaluation Harness
   slug: experimental-evaluation-harness-api
-  order: 40
+  order: 20
   markdown:
     descriptive_class_title: false
     classdef_code_block: false

diff --git a/docs/pydoc/config/generators_api.yml b/docs/pydoc/config/generators_api.yml
@@ -17,7 +17,7 @@ renderer:
   category_slug: experiments-api
   title: Generators
   slug: experimental-generators-api
-  order: 60
+  order: 30
   markdown:
     descriptive_class_title: false
     classdef_code_block: false

diff --git a/docs/pydoc/config/retrievers_api.yml b/docs/pydoc/config/retrievers_api.yml
@@ -25,7 +25,7 @@ renderer:
   category_slug: experiments-api
   title: Retrievers
   slug: experimental-retrievers-api
-  order: 80
+  order: 40
   markdown:
     descriptive_class_title: false
     classdef_code_block: false

diff --git a/docs/pydoc/config/splitters_api.yml b/docs/pydoc/config/splitters_api.yml
@@ -17,7 +17,7 @@ renderer:
   category_slug: experiments-api
   title: Splitters
   slug: experimental-splitters-api
-  order: 100
+  order: 50
   markdown:
     descriptive_class_title: false
     classdef_code_block: false

diff --git a/docs/pydoc/config/extractors_api.yml → docs/pydoc/config/supercomponent_api.yml b/docs/pydoc/config/extractors_api.yml → docs/pydoc/config/supercomponent_api.yml
@@ -1,7 +1,10 @@
 loaders:
   - type: haystack_pydoc_tools.loaders.CustomPythonLoader
     search_path: [../../../]
-    modules: ["haystack_experimental.components.extractors.llm_metadata_extractor"]
+    modules:
+      [
+        "haystack_experimental.core.super_component.super_component"
+      ]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter
@@ -13,15 +16,15 @@ processors:
   - type: crossref
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
-  excerpt: Extracting information from documents.
+  excerpt: A class for creating super components that wrap around a pipeline.
   category_slug: experiments-api
-  title: Extractors
-  slug: experimental-generators-api
-  order: 50
+  title: SuperComponent
+  slug: experimental-supercomponent-api
+  order: 60
   markdown:
     descriptive_class_title: false
     classdef_code_block: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: experimental_extractors.md
+    filename: experimental_supercomponent_api.md
diff --git a/docs/pydoc/config/writers_api.yml b/docs/pydoc/config/writers_api.yml
@@ -21,7 +21,7 @@ renderer:
   category_slug: experiments-api
   title: Writers
   slug: experimental-writers-api
-  order: 140
+  order: 70
   markdown:
     descriptive_class_title: false
     classdef_code_block: false