Skip to content

Commit f7ec015

Browse files
anakin87anakin87
authored
docs: add pydoc configurations for Docusaurus (#2411)
* docs: add pydoc configurations for Docusaurus * rm file
1 parent f8ed349 commit f7ec015

File tree

40 files changed

+1217
-0
lines changed

40 files changed

+1217
-0
lines changed

‎integrations/aimlapi/pydoc/config_docusaurus.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.components.generators.aimlapi.chat.chat_generator
6+
search_path:
7+
- ../src
8+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
9+
processors:
10+
- do_not_filter_modules: false
11+
documented_only: true
12+
expression: null
13+
skip_empty_modules: true
14+
type: filter
15+
- type: smart
16+
- type: crossref
17+
renderer:
18+
description: AIMLAPI integration for Haystack
19+
id: integrations-aimlapi
20+
markdown:
21+
add_member_class_prefix: false
22+
add_method_class_prefix: true
23+
classdef_code_block: false
24+
descriptive_class_title: false
25+
descriptive_module_title: true
26+
filename: aimlapi.md
27+
title: AIMLAPI
28+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

‎integrations/amazon_bedrock/pydoc/config_docusaurus.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.common.amazon_bedrock.errors
6+
- haystack_integrations.components.embedders.amazon_bedrock.document_embedder
7+
- haystack_integrations.components.embedders.amazon_bedrock.text_embedder
8+
- haystack_integrations.components.embedders.amazon_bedrock.document_image_embedder
9+
- haystack_integrations.components.generators.amazon_bedrock.generator
10+
- haystack_integrations.components.generators.amazon_bedrock.adapters
11+
- haystack_integrations.common.amazon_bedrock.errors
12+
- haystack_integrations.components.generators.amazon_bedrock.chat.chat_generator
13+
- haystack_integrations.components.rankers.amazon_bedrock.ranker
14+
- haystack_integrations.components.downloaders.s3.s3_downloader
15+
- haystack_integrations.common.s3.utils
16+
- haystack_integrations.common.s3.errors
17+
search_path:
18+
- ../src
19+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
20+
processors:
21+
- do_not_filter_modules: false
22+
documented_only: true
23+
expression: null
24+
skip_empty_modules: true
25+
type: filter
26+
- expression: name not in ['BedrockRanker']
27+
type: filter
28+
- type: smart
29+
- type: crossref
30+
renderer:
31+
description: Amazon Bedrock integration for Haystack
32+
id: integrations-amazon-bedrock
33+
markdown:
34+
add_member_class_prefix: false
35+
add_method_class_prefix: true
36+
classdef_code_block: false
37+
descriptive_class_title: false
38+
descriptive_module_title: true
39+
filename: amazon_bedrock.md
40+
title: Amazon Bedrock
41+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

‎integrations/amazon_sagemaker/pydoc/config_docusaurus.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.components.generators.amazon_sagemaker.sagemaker
6+
search_path:
7+
- ../src
8+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
9+
processors:
10+
- do_not_filter_modules: false
11+
documented_only: true
12+
expression: null
13+
skip_empty_modules: true
14+
type: filter
15+
- type: smart
16+
- type: crossref
17+
renderer:
18+
description: Amazon Sagemaker integration for Haystack
19+
id: integrations-amazon-sagemaker
20+
markdown:
21+
add_member_class_prefix: false
22+
add_method_class_prefix: true
23+
classdef_code_block: false
24+
descriptive_class_title: false
25+
descriptive_module_title: true
26+
filename: amazon_sagemaker.md
27+
title: Amazon Sagemaker
28+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

‎integrations/anthropic/pydoc/config_docusaurus.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.components.generators.anthropic.generator
6+
- haystack_integrations.components.generators.anthropic.chat.chat_generator
7+
- haystack_integrations.components.generators.anthropic.chat.vertex_chat_generator
8+
search_path:
9+
- ../src
10+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
11+
processors:
12+
- do_not_filter_modules: false
13+
documented_only: true
14+
expression: null
15+
skip_empty_modules: true
16+
type: filter
17+
- type: smart
18+
- type: crossref
19+
renderer:
20+
description: Anthropic integration for Haystack
21+
id: integrations-anthropic
22+
markdown:
23+
add_member_class_prefix: false
24+
add_method_class_prefix: true
25+
descriptive_class_title: false
26+
descriptive_module_title: true
27+
filename: anthropic.md
28+
title: Anthropic
29+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

‎integrations/astra/pydoc/config_docusaurus.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.components.retrievers.astra.retriever
6+
- haystack_integrations.document_stores.astra.document_store
7+
- haystack_integrations.document_stores.astra.errors
8+
search_path:
9+
- ../src
10+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
11+
processors:
12+
- do_not_filter_modules: false
13+
documented_only: true
14+
expression: null
15+
skip_empty_modules: true
16+
type: filter
17+
- type: smart
18+
- type: crossref
19+
renderer:
20+
description: Astra integration for Haystack
21+
id: integrations-astra
22+
markdown:
23+
add_member_class_prefix: false
24+
add_method_class_prefix: true
25+
classdef_code_block: false
26+
descriptive_class_title: false
27+
descriptive_module_title: true
28+
filename: astra.md
29+
title: Astra
30+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

‎integrations/azure_ai_search/pydoc/config_docusaurus.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.components.retrievers.azure_ai_search.embedding_retriever
6+
- haystack_integrations.document_stores.azure_ai_search.document_store
7+
- haystack_integrations.document_stores.azure_ai_search.filters
8+
search_path:
9+
- ../src
10+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
11+
processors:
12+
- do_not_filter_modules: false
13+
documented_only: true
14+
expression: null
15+
skip_empty_modules: true
16+
type: filter
17+
- type: smart
18+
- type: crossref
19+
renderer:
20+
description: Azure AI Search integration for Haystack
21+
id: integrations-azure_ai_search
22+
markdown:
23+
add_member_class_prefix: false
24+
add_method_class_prefix: true
25+
classdef_code_block: false
26+
descriptive_class_title: false
27+
descriptive_module_title: true
28+
filename: azure_ai_search.md
29+
title: Azure AI Search
30+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

‎integrations/chroma/pydoc/config_docusaurus.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.components.retrievers.chroma.retriever
6+
- haystack_integrations.document_stores.chroma.document_store
7+
- haystack_integrations.document_stores.chroma.errors
8+
- haystack_integrations.document_stores.chroma.utils
9+
search_path:
10+
- ../src
11+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
12+
processors:
13+
- do_not_filter_modules: false
14+
documented_only: true
15+
expression: null
16+
skip_empty_modules: true
17+
type: filter
18+
- type: smart
19+
- type: crossref
20+
renderer:
21+
description: Chroma integration for Haystack
22+
id: integrations-chroma
23+
markdown:
24+
add_member_class_prefix: false
25+
add_method_class_prefix: true
26+
classdef_code_block: false
27+
descriptive_class_title: false
28+
descriptive_module_title: true
29+
filename: chroma.md
30+
title: Chroma
31+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

‎integrations/cohere/pydoc/config_docusaurus.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.components.embedders.cohere.document_embedder
6+
- haystack_integrations.components.embedders.cohere.document_image_embedder
7+
- haystack_integrations.components.embedders.cohere.text_embedder
8+
- haystack_integrations.components.embedders.cohere.utils
9+
- haystack_integrations.components.generators.cohere.generator
10+
- haystack_integrations.components.generators.cohere.chat.chat_generator
11+
- haystack_integrations.components.rankers.cohere.ranker
12+
search_path:
13+
- ../src
14+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
15+
processors:
16+
- do_not_filter_modules: false
17+
documented_only: true
18+
expression: null
19+
skip_empty_modules: true
20+
type: filter
21+
- type: smart
22+
- type: crossref
23+
renderer:
24+
description: Cohere integration for Haystack
25+
id: integrations-cohere
26+
markdown:
27+
add_member_class_prefix: false
28+
add_method_class_prefix: true
29+
classdef_code_block: false
30+
descriptive_class_title: false
31+
descriptive_module_title: true
32+
filename: cohere.md
33+
title: Cohere
34+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

‎integrations/deepeval/pydoc/config_docusaurus.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.components.evaluators.deepeval.evaluator
6+
- haystack_integrations.components.evaluators.deepeval.metrics
7+
search_path:
8+
- ../src
9+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
10+
processors:
11+
- do_not_filter_modules: false
12+
documented_only: true
13+
expression: null
14+
skip_empty_modules: true
15+
type: filter
16+
- expression: name not in ['MetricResult', 'MetricDescriptor', 'OutputConverters',
17+
'InputConverters', 'METRIC_DESCRIPTORS']
18+
type: filter
19+
- type: smart
20+
- type: crossref
21+
renderer:
22+
description: DeepEval integration for Haystack
23+
id: integrations-deepeval
24+
markdown:
25+
add_member_class_prefix: false
26+
add_method_class_prefix: true
27+
classdef_code_block: false
28+
descriptive_class_title: false
29+
descriptive_module_title: true
30+
filename: deepeval.md
31+
title: DeepEval
32+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

‎integrations/elasticsearch/pydoc/config_docusaurus.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
loaders:
2+
- ignore_when_discovered:
3+
- __init__
4+
modules:
5+
- haystack_integrations.components.retrievers.elasticsearch.bm25_retriever
6+
- haystack_integrations.components.retrievers.elasticsearch.embedding_retriever
7+
- haystack_integrations.document_stores.elasticsearch.document_store
8+
- haystack_integrations.document_stores.elasticsearch.filters
9+
search_path:
10+
- ../src
11+
type: haystack_pydoc_tools.loaders.CustomPythonLoader
12+
processors:
13+
- do_not_filter_modules: false
14+
documented_only: true
15+
expression: null
16+
skip_empty_modules: true
17+
type: filter
18+
- type: smart
19+
- type: crossref
20+
renderer:
21+
description: Elasticsearch integration for Haystack
22+
id: integrations-elasticsearch
23+
markdown:
24+
add_member_class_prefix: false
25+
add_method_class_prefix: true
26+
classdef_code_block: false
27+
descriptive_class_title: false
28+
descriptive_module_title: true
29+
filename: elasticsearch.md
30+
title: Elasticsearch
31+
type: haystack_pydoc_tools.renderers.DocusaurusRenderer

0 commit comments

Comments
 (0)