diff --git a/docs/pydoc/config/crawler.yml b/docs/pydoc/config/crawler.yml index f5d50e76d..6528da857 100644 --- a/docs/pydoc/config/crawler.yml +++ b/docs/pydoc/config/crawler.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: crawler_api.md + diff --git a/docs/pydoc/config/document-classifier.yml b/docs/pydoc/config/document-classifier.yml index 5fae36149..0ade0897d 100644 --- a/docs/pydoc/config/document-classifier.yml +++ b/docs/pydoc/config/document-classifier.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: document_classifier_api.md + diff --git a/docs/pydoc/config/extractor.yml b/docs/pydoc/config/extractor.yml index 29de80b49..bfa121d4b 100644 --- a/docs/pydoc/config/extractor.yml +++ b/docs/pydoc/config/extractor.yml @@ -26,3 +26,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: entity_extractor_api.md + diff --git a/docs/pydoc/config/file-classifier.yml b/docs/pydoc/config/file-classifier.yml index d9345e791..2b8872629 100644 --- a/docs/pydoc/config/file-classifier.yml +++ b/docs/pydoc/config/file-classifier.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: file_classifier_api.md + diff --git a/docs/pydoc/config/file-converters.yml b/docs/pydoc/config/file-converters.yml index 819ef88ad..47e0eb370 100644 --- a/docs/pydoc/config/file-converters.yml +++ b/docs/pydoc/config/file-converters.yml @@ -36,3 +36,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: file_converters_api.md + diff --git a/docs/pydoc/config/other.yml b/docs/pydoc/config/other.yml index 7458aa9dc..0aa453376 100644 --- a/docs/pydoc/config/other.yml +++ b/docs/pydoc/config/other.yml @@ -32,3 +32,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: other_api.md + diff --git a/docs/pydoc/config/pipelines.yml b/docs/pydoc/config/pipelines.yml index aaf3ea4c1..8607d0d56 100644 --- a/docs/pydoc/config/pipelines.yml +++ b/docs/pydoc/config/pipelines.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: pipelines_api.md + diff --git a/docs/pydoc/config/preprocessor.yml b/docs/pydoc/config/preprocessor.yml index 675d7f03b..1eb437aea 100644 --- a/docs/pydoc/config/preprocessor.yml +++ b/docs/pydoc/config/preprocessor.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: preprocessor_api.md + diff --git a/docs/pydoc/config/primitives.yml b/docs/pydoc/config/primitives.yml index d7c439b45..6b8c3c8d1 100644 --- a/docs/pydoc/config/primitives.yml +++ b/docs/pydoc/config/primitives.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: primitives_api.md + diff --git a/docs/pydoc/config/prompt-node.yml b/docs/pydoc/config/prompt-node.yml index 8797e2d0b..c9aff2129 100644 --- a/docs/pydoc/config/prompt-node.yml +++ b/docs/pydoc/config/prompt-node.yml @@ -26,3 +26,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: prompt_node_api.md + diff --git a/docs/pydoc/config/pseudo-label-generator.yml b/docs/pydoc/config/pseudo-label-generator.yml index 6557db49f..e1df263fd 100644 --- a/docs/pydoc/config/pseudo-label-generator.yml +++ b/docs/pydoc/config/pseudo-label-generator.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: pseudo_label_generator_api.md + diff --git a/docs/pydoc/config/query-classifier.yml b/docs/pydoc/config/query-classifier.yml index 7a52b0956..04c8b19a2 100644 --- a/docs/pydoc/config/query-classifier.yml +++ b/docs/pydoc/config/query-classifier.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: query_classifier_api.md + diff --git a/docs/pydoc/config/question-generator.yml b/docs/pydoc/config/question-generator.yml index 9483250a6..72a0c5c22 100644 --- a/docs/pydoc/config/question-generator.yml +++ b/docs/pydoc/config/question-generator.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: question_generator_api.md + diff --git a/docs/pydoc/config/ranker.yml b/docs/pydoc/config/ranker.yml index b39130bcb..5c0917dd7 100644 --- a/docs/pydoc/config/ranker.yml +++ b/docs/pydoc/config/ranker.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: ranker_api.md + diff --git a/docs/pydoc/config/reader.yml b/docs/pydoc/config/reader.yml index 161cd58aa..a36efd109 100644 --- a/docs/pydoc/config/reader.yml +++ b/docs/pydoc/config/reader.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: reader_api.md + diff --git a/docs/pydoc/config/retriever.yml b/docs/pydoc/config/retriever.yml index e09bd0537..a75d9ee22 100644 --- a/docs/pydoc/config/retriever.yml +++ b/docs/pydoc/config/retriever.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: retriever_api.md + diff --git a/docs/pydoc/config/shaper.yml b/docs/pydoc/config/shaper.yml new file mode 100644 index 000000000..bae985a13 --- /dev/null +++ b/docs/pydoc/config/shaper.yml @@ -0,0 +1,26 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/other/shaper] + modules: ['shaper'] + 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: A helper node with a variety of functions. + category_slug: haystack-classes + title: Shaper API + slug: shaper-api + order: 175 + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: shaper_api.md diff --git a/docs/pydoc/config/transformers-img-to-text.yml b/docs/pydoc/config/transformers-img-to-text.yml index 4cb20288e..36ad30856 100644 --- a/docs/pydoc/config/transformers-img-to-text.yml +++ b/docs/pydoc/config/transformers-img-to-text.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: transformers-image-to-text.md + diff --git a/docs/pydoc/config/translator.yml b/docs/pydoc/config/translator.yml index d1e230cd7..ee8a90318 100644 --- a/docs/pydoc/config/translator.yml +++ b/docs/pydoc/config/translator.yml @@ -24,3 +24,4 @@ renderer: add_method_class_prefix: true add_member_class_prefix: false filename: translator_api.md +