docs: separate abstract classes into separate API references (#5501)

* separate_abstractions

* img-to-text parent slug upd

* Apply suggestions from code review

Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>

---------

Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>

docs/pydoc/config/answer-generator.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/answer_generator]
-    modules: ["base", "openai"]
+    modules: ["openai"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/base-converter.yml

@@ -0,0 +1,27 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/file_converter]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for implementing file converters.
+  category_slug: haystack-classes
+  title: Base Converters API
+  slug: base-converters-api
+  order: 72
+  parent_doc_slug: file-converters-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_converters_api.md

docs/pydoc/config/base-doc-language-classifier.yml

@@ -0,0 +1,27 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/doc_language_classifier]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for Document Language Classifiers.
+  category_slug: haystack-classes
+  title: Base Document Language Classifier API
+  slug: base-doc-language-classifier-api
+  order: 27
+  parent_doc_slug: doc-language-classifier-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_doc_language_classifier_api.md

docs/pydoc/config/base-document-classifier.yml

@@ -0,0 +1,28 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/document_classifier]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for the Document Classifer.
+  category_slug: haystack-classes
+  title: Base Document Classifier API
+  slug: base-document-classifier-api
+  order: 22
+  parent_doc_slug: document-classifier-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_document_classifier_api.md
+

docs/pydoc/config/base-document-store.yml

@@ -0,0 +1,27 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/document_stores]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract classes for the Document Stores and Keyword Document Stores.
+  category_slug: haystack-classes
+  title: Base Document Store API
+  slug: base-document-store-api
+  order: 32
+  parent_doc_slug: document-store-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_document_store_api.md

docs/pydoc/config/base-generator.yml

@@ -0,0 +1,27 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/answer_generator]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for Generators.
+  category_slug: haystack-classes
+  title: BaseGenerator API
+  slug: basegenerator-api
+  order: 7
+  parent_doc_slug: answer-generator-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: basegenerator_api.md

docs/pydoc/config/base-image-to-text.yml

@@ -0,0 +1,28 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/image_to_text]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for ImageToText.
+  category_slug: haystack-classes
+  title: BaseImageToText API
+  slug: base-image-to-text-api
+  order: 187
+  parent_doc_slug: transformers-image-to-text-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base-image-to-text.md
+

docs/pydoc/config/base-preprocessor.yml

@@ -0,0 +1,28 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/preprocessor]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for the PreProcessor.
+  category_slug: haystack-classes
+  title: Base PreProcessor API
+  slug: base-preprocessor-api
+  order: 102
+  parent_doc_slug: preprocessor-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_preprocessor_api.md
+

docs/pydoc/config/base-query-classifier.yml

@@ -0,0 +1,28 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/query_classifier]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for Query Classifiers.
+  category_slug: haystack-classes
+  title: Base Query Classifier API
+  slug: base-query-classifier-api
+  order: 132
+  parent_doc_slug: query-classifier-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: query_classifier_api.md
+

docs/pydoc/config/base-ranker.yml

@@ -0,0 +1,27 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/ranker]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for Rankers.
+  category_slug: haystack-classes
+  title: Base Ranker API
+  slug: base-ranker-api
+  order: 152
+  parent_doc_slug: ranker-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_ranker_api.md

docs/pydoc/config/base-reader.yml

@@ -0,0 +1,28 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/reader]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for Readers.
+  category_slug: haystack-classes
+  title: Base Reader API
+  slug: base-reader-api
+  order: 162
+  parent_doc_slug: reader-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_reader_api.md
+

docs/pydoc/config/base-retriever.yml

@@ -0,0 +1,27 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/retriever]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for Retrievers.
+  category_slug: haystack-classes
+  title: Base Retriever API
+  slug: base-retriever-api
+  order: 172
+  parent_doc_slug: retriever-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_retriever_api.md

docs/pydoc/config/base-summarizer.yml

@@ -0,0 +1,27 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/summarizer]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for Summarizers.
+  category_slug: haystack-classes
+  title: Base Summarizer API
+  slug: base-summarizer-api
+  order: 182
+  parent_doc_slug: summarizer-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_summarizer_api.md

docs/pydoc/config/base-translator.yml

@@ -0,0 +1,28 @@
+loaders:
+  - type: python
+    search_path: [../../../haystack/nodes/translator]
+    modules: ["base"]
+    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: renderers.ReadmeRenderer
+  excerpt: Abstract class for Translators.
+  category_slug: haystack-classes
+  title: Base Translator API
+  slug: base-translator-api
+  order: 192
+  parent_doc_slug: translator-api
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: base_translator_api.md
+

docs/pydoc/config/doc-language-classifier.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/doc_language_classifier]
-    modules: ["base", "langdetect", "transformers"]
+    modules: ["langdetect", "transformers"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/document-classifier.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/document_classifier]
-    modules: ["base", "transformers"]
+    modules: ["transformers"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/document-store.yml

@@ -3,7 +3,6 @@ loaders:
     search_path: [../../../haystack/document_stores, ../../../haystack/document_stores/elasticsearch]
     modules:
       [
-        "base",
         "es7",
         "es8",
         "opensearch",

docs/pydoc/config/file-converters.yml

@@ -3,7 +3,6 @@ loaders:
     search_path: [../../../haystack/nodes/file_converter]
     modules:
       [
-        "base",
         "csv",
         "docx",
         "image",

docs/pydoc/config/preprocessor.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/preprocessor]
-    modules: ["base", "preprocessor"]
+    modules: ["preprocessor"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/query-classifier.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/query_classifier]
-    modules: ["base", "sklearn", "transformers"]
+    modules: ["sklearn", "transformers"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/ranker.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/ranker]
-    modules: ["base", "sentence_transformers", "recentness_ranker", "diversity", "lost_in_the_middle"]
+    modules: ["sentence_transformers", "recentness_ranker", "diversity", "lost_in_the_middle"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/reader.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/reader]
-    modules: ["base", "farm", "transformers", "table"]
+    modules: ["farm", "transformers", "table"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/retriever.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/retriever]
-    modules: ["base", "sparse", "dense", "multimodal/retriever", "web", "link_content"]
+    modules: ["sparse", "dense", "multimodal/retriever", "web", "link_content"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/summarizer.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/summarizer]
-    modules: ["base", "transformers"]
+    modules: ["transformers"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/transformers-img-to-text.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/image_to_text]
-    modules: ["base", "transformers"]
+    modules: ["transformers"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter

docs/pydoc/config/translator.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/nodes/translator]
-    modules: ["base", "transformers"]
+    modules: ["transformers"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter