diff --git a/docs/pydoc/config/embedder.yml b/docs/pydoc/config/embedder.yml index 561f95134..6e74439f5 100644 --- a/docs/pydoc/config/embedder.yml +++ b/docs/pydoc/config/embedder.yml @@ -1,7 +1,17 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/components/embedders] - modules: ["openai_document_embedder", "openai_text_embedder", "sentence_transformers_document_embedder", "sentence_transformers_text_embedder"] + modules: + [ + "azure_document_embedder", + "azure_text_embedder", + "hugging_face_tei_document_embedder", + "hugging_face_tei_text_embedder", + "openai_document_embedder", + "openai_text_embedder", + "sentence_transformers_document_embedder", + "sentence_transformers_text_embedder" + ] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/extractor.yml b/docs/pydoc/config/extractor.yml new file mode 100644 index 000000000..3caed6149 --- /dev/null +++ b/docs/pydoc/config/extractor.yml @@ -0,0 +1,26 @@ +loaders: + - type: loaders.CustomPythonLoader + search_path: [../../../haystack/components/extractors] + modules: ["named_entity_extractor"] + 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.ReadmePreviewRenderer + excerpt: Extracts predefined entities out of a piece of text. + category_slug: haystack-classes + title: Extractor API + slug: extractor-api + order: 65 + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: extractor_api.md diff --git a/docs/pydoc/config/generator.yml b/docs/pydoc/config/generator.yml index 2e4604220..3a2a67806 100644 --- a/docs/pydoc/config/generator.yml +++ b/docs/pydoc/config/generator.yml @@ -1,7 +1,17 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/components/generators] - modules: ["hugging_face_local", "hugging_face_tgi", "openai", "chat/hugging_face_tgi", "chat/openai"] + modules: + [ + "azure", + "hugging_face_local", + "hugging_face_tgi", + "openai", + "chat/azure", + "chat/hugging_face_local", + "chat/hugging_face_tgi", + "chat/openai" + ] ignore_when_discovered: ["__init__"] processors: - type: filter