diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08bd09c43a..30776f9ff6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -273,17 +273,15 @@ change the code to also change relevant comments and docstrings. This type of do developers, but it can be handy for users at times. You can browse it on the dedicated section in the [documentation website](https://docs.haystack.deepset.ai/reference/integrations-chroma). -We use `pydoc-markdown` to convert docstrings into properly formatted Markdown files, and while the CI takes care of -generating and publishing the updated documentation at every merge on the `main` branch, you can generate the docs +We use [`haystack-pydoc-tools`](https://github.com/deepset-ai/haystack-pydoc-tools) to convert docstrings into properly formatted Markdown files, and while the CI takes care of +generating and publishing the updated documentation once a new version is released, you can generate the docs locally using Hatch. From an integration folder: ```console $ hatch run docs ``` -If you see a warning referring to a missing `README_API_KEY` env var, that's expected. - -If you want to customise the conversion process, the `pydoc-markdown` config files are stored in a `pydoc/` folder +If you want to customise the conversion process, the `haystack-pydoc-tools` config files are stored in a `pydoc/` folder for each integration. #### Documentation pages diff --git a/integrations/aimlapi/pydoc/config_docusaurus.yml b/integrations/aimlapi/pydoc/config_docusaurus.yml index 559e4839a6..4ca6a6943c 100644 --- a/integrations/aimlapi/pydoc/config_docusaurus.yml +++ b/integrations/aimlapi/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.aimlapi.chat.chat_generator - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.aimlapi.chat.chat_generator + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: AIMLAPI integration for Haystack id: integrations-aimlapi - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: aimlapi.md + filename: aimlapi.md title: AIMLAPI - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/aimlapi/pyproject.toml b/integrations/aimlapi/pyproject.toml index 3d7b57253a..c99e0f7871 100644 --- a/integrations/aimlapi/pyproject.toml +++ b/integrations/aimlapi/pyproject.toml @@ -44,7 +44,7 @@ git_describe_command = 'git describe --tags --match="integrations/aimlapi-v[0-9] installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/amazon_bedrock/pydoc/config_docusaurus.yml b/integrations/amazon_bedrock/pydoc/config_docusaurus.yml index 86d885cf30..e5aff1e9b5 100644 --- a/integrations/amazon_bedrock/pydoc/config_docusaurus.yml +++ b/integrations/amazon_bedrock/pydoc/config_docusaurus.yml @@ -1,41 +1,24 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.common.amazon_bedrock.errors - - haystack_integrations.components.embedders.amazon_bedrock.document_embedder - - haystack_integrations.components.embedders.amazon_bedrock.text_embedder - - haystack_integrations.components.embedders.amazon_bedrock.document_image_embedder - - haystack_integrations.components.generators.amazon_bedrock.generator - - haystack_integrations.components.generators.amazon_bedrock.adapters - - haystack_integrations.common.amazon_bedrock.errors - - haystack_integrations.components.generators.amazon_bedrock.chat.chat_generator - - haystack_integrations.components.rankers.amazon_bedrock.ranker - - haystack_integrations.components.downloaders.s3.s3_downloader - - haystack_integrations.common.s3.utils - - haystack_integrations.common.s3.errors - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.common.amazon_bedrock.errors + - haystack_integrations.components.embedders.amazon_bedrock.document_embedder + - haystack_integrations.components.embedders.amazon_bedrock.text_embedder + - haystack_integrations.components.embedders.amazon_bedrock.document_image_embedder + - haystack_integrations.components.generators.amazon_bedrock.generator + - haystack_integrations.components.generators.amazon_bedrock.adapters + - haystack_integrations.common.amazon_bedrock.errors + - haystack_integrations.components.generators.amazon_bedrock.chat.chat_generator + - haystack_integrations.components.rankers.amazon_bedrock.ranker + - haystack_integrations.components.downloaders.s3.s3_downloader + - haystack_integrations.common.s3.utils + - haystack_integrations.common.s3.errors + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- expression: name not in ['BedrockRanker'] - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Amazon Bedrock integration for Haystack id: integrations-amazon-bedrock - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: amazon_bedrock.md + filename: amazon_bedrock.md title: Amazon Bedrock - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/amazon_bedrock/pyproject.toml b/integrations/amazon_bedrock/pyproject.toml index 9300b2c7eb..36f13651ec 100644 --- a/integrations/amazon_bedrock/pyproject.toml +++ b/integrations/amazon_bedrock/pyproject.toml @@ -45,7 +45,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/amazon_sagemaker/pydoc/config_docusaurus.yml b/integrations/amazon_sagemaker/pydoc/config_docusaurus.yml index 50ef46d176..c0f9623e46 100644 --- a/integrations/amazon_sagemaker/pydoc/config_docusaurus.yml +++ b/integrations/amazon_sagemaker/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.amazon_sagemaker.sagemaker - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.amazon_sagemaker.sagemaker + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Amazon Sagemaker integration for Haystack id: integrations-amazon-sagemaker - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: amazon_sagemaker.md + filename: amazon_sagemaker.md title: Amazon Sagemaker - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/amazon_sagemaker/pyproject.toml b/integrations/amazon_sagemaker/pyproject.toml index d020920002..88dee76b2f 100644 --- a/integrations/amazon_sagemaker/pyproject.toml +++ b/integrations/amazon_sagemaker/pyproject.toml @@ -47,7 +47,7 @@ git_describe_command = 'git describe --tags --match="integrations/amazon_sagemak installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/anthropic/pydoc/config_docusaurus.yml b/integrations/anthropic/pydoc/config_docusaurus.yml index 8019c7a45e..64110ffb6a 100644 --- a/integrations/anthropic/pydoc/config_docusaurus.yml +++ b/integrations/anthropic/pydoc/config_docusaurus.yml @@ -1,29 +1,15 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.anthropic.generator - - haystack_integrations.components.generators.anthropic.chat.chat_generator - - haystack_integrations.components.generators.anthropic.chat.vertex_chat_generator - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.anthropic.generator + - haystack_integrations.components.generators.anthropic.chat.chat_generator + - haystack_integrations.components.generators.anthropic.chat.vertex_chat_generator + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Anthropic integration for Haystack id: integrations-anthropic - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - descriptive_class_title: false - descriptive_module_title: true - filename: anthropic.md + filename: anthropic.md title: Anthropic - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/anthropic/pyproject.toml b/integrations/anthropic/pyproject.toml index a46f9ab860..e7a1998ab6 100644 --- a/integrations/anthropic/pyproject.toml +++ b/integrations/anthropic/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/astra/pydoc/config_docusaurus.yml b/integrations/astra/pydoc/config_docusaurus.yml index 6c42cb49a8..3970e67d39 100644 --- a/integrations/astra/pydoc/config_docusaurus.yml +++ b/integrations/astra/pydoc/config_docusaurus.yml @@ -1,30 +1,15 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.astra.retriever - - haystack_integrations.document_stores.astra.document_store - - haystack_integrations.document_stores.astra.errors - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.astra.retriever + - haystack_integrations.document_stores.astra.document_store + - haystack_integrations.document_stores.astra.errors + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Astra integration for Haystack id: integrations-astra - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: astra.md + filename: astra.md title: Astra - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/astra/pyproject.toml b/integrations/astra/pyproject.toml index b1325354ce..c9cea46ec3 100644 --- a/integrations/astra/pyproject.toml +++ b/integrations/astra/pyproject.toml @@ -49,7 +49,7 @@ git_describe_command = 'git describe --tags --match="integrations/astra-v[0-9]*" installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/azure_ai_search/pydoc/config_docusaurus.yml b/integrations/azure_ai_search/pydoc/config_docusaurus.yml index 632ebac2d0..0b430cd109 100644 --- a/integrations/azure_ai_search/pydoc/config_docusaurus.yml +++ b/integrations/azure_ai_search/pydoc/config_docusaurus.yml @@ -1,30 +1,15 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.azure_ai_search.embedding_retriever - - haystack_integrations.document_stores.azure_ai_search.document_store - - haystack_integrations.document_stores.azure_ai_search.filters - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.azure_ai_search.embedding_retriever + - haystack_integrations.document_stores.azure_ai_search.document_store + - haystack_integrations.document_stores.azure_ai_search.filters + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Azure AI Search integration for Haystack id: integrations-azure_ai_search - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: azure_ai_search.md + filename: azure_ai_search.md title: Azure AI Search - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/azure_ai_search/pyproject.toml b/integrations/azure_ai_search/pyproject.toml index 57fa4f6963..9edc616ec4 100644 --- a/integrations/azure_ai_search/pyproject.toml +++ b/integrations/azure_ai_search/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/azure_doc_intelligence/pydoc/config_docusaurus.yml b/integrations/azure_doc_intelligence/pydoc/config_docusaurus.yml index be82b47977..cd47ac8981 100644 --- a/integrations/azure_doc_intelligence/pydoc/config_docusaurus.yml +++ b/integrations/azure_doc_intelligence/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.converters.azure_doc_intelligence.converter - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.converters.azure_doc_intelligence.converter + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Azure Document Intelligence integration for Haystack id: integrations-azure_doc_intelligence - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: azure_doc_intelligence.md + filename: azure_doc_intelligence.md title: Azure Document Intelligence - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/azure_doc_intelligence/pyproject.toml b/integrations/azure_doc_intelligence/pyproject.toml index 64542579d9..dd260976a8 100644 --- a/integrations/azure_doc_intelligence/pyproject.toml +++ b/integrations/azure_doc_intelligence/pyproject.toml @@ -56,7 +56,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/chroma/pydoc/config_docusaurus.yml b/integrations/chroma/pydoc/config_docusaurus.yml index bb1644c5dc..550cb805be 100644 --- a/integrations/chroma/pydoc/config_docusaurus.yml +++ b/integrations/chroma/pydoc/config_docusaurus.yml @@ -1,31 +1,16 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.chroma.retriever - - haystack_integrations.document_stores.chroma.document_store - - haystack_integrations.document_stores.chroma.errors - - haystack_integrations.document_stores.chroma.utils - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.chroma.retriever + - haystack_integrations.document_stores.chroma.document_store + - haystack_integrations.document_stores.chroma.errors + - haystack_integrations.document_stores.chroma.utils + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Chroma integration for Haystack id: integrations-chroma - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: chroma.md + filename: chroma.md title: Chroma - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/chroma/pyproject.toml b/integrations/chroma/pyproject.toml index c5eb5ff205..a9a82d6e52 100644 --- a/integrations/chroma/pyproject.toml +++ b/integrations/chroma/pyproject.toml @@ -48,7 +48,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/cohere/pydoc/config_docusaurus.yml b/integrations/cohere/pydoc/config_docusaurus.yml index d9e82683be..c7a5acf3ca 100644 --- a/integrations/cohere/pydoc/config_docusaurus.yml +++ b/integrations/cohere/pydoc/config_docusaurus.yml @@ -1,34 +1,19 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.embedders.cohere.document_embedder - - haystack_integrations.components.embedders.cohere.document_image_embedder - - haystack_integrations.components.embedders.cohere.text_embedder - - haystack_integrations.components.embedders.cohere.utils - - haystack_integrations.components.generators.cohere.generator - - haystack_integrations.components.generators.cohere.chat.chat_generator - - haystack_integrations.components.rankers.cohere.ranker - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.embedders.cohere.document_embedder + - haystack_integrations.components.embedders.cohere.document_image_embedder + - haystack_integrations.components.embedders.cohere.text_embedder + - haystack_integrations.components.embedders.cohere.utils + - haystack_integrations.components.generators.cohere.generator + - haystack_integrations.components.generators.cohere.chat.chat_generator + - haystack_integrations.components.rankers.cohere.ranker + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Cohere integration for Haystack id: integrations-cohere - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: cohere.md + filename: cohere.md title: Cohere - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/cohere/pyproject.toml b/integrations/cohere/pyproject.toml index a2000b8390..5157ab33f1 100644 --- a/integrations/cohere/pyproject.toml +++ b/integrations/cohere/pyproject.toml @@ -45,7 +45,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/cometapi/pydoc/config_docusaurus.yml b/integrations/cometapi/pydoc/config_docusaurus.yml index 73f204d42f..b66c546a0e 100644 --- a/integrations/cometapi/pydoc/config_docusaurus.yml +++ b/integrations/cometapi/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.cometapi.chat.chat_generator - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.cometapi.chat.chat_generator + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Comet API integration for Haystack id: integrations-cometapi - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: cometapi.md + filename: cometapi.md title: Comet API - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/cometapi/pyproject.toml b/integrations/cometapi/pyproject.toml index fa301eb570..d06429d2f3 100644 --- a/integrations/cometapi/pyproject.toml +++ b/integrations/cometapi/pyproject.toml @@ -48,7 +48,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/deepeval/pydoc/config_docusaurus.yml b/integrations/deepeval/pydoc/config_docusaurus.yml index a772da58e2..adf9110ba5 100644 --- a/integrations/deepeval/pydoc/config_docusaurus.yml +++ b/integrations/deepeval/pydoc/config_docusaurus.yml @@ -1,32 +1,14 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.evaluators.deepeval.evaluator - - haystack_integrations.components.evaluators.deepeval.metrics - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.evaluators.deepeval.evaluator + - haystack_integrations.components.evaluators.deepeval.metrics + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- expression: name not in ['MetricResult', 'MetricDescriptor', 'OutputConverters', - 'InputConverters', 'METRIC_DESCRIPTORS'] - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: DeepEval integration for Haystack id: integrations-deepeval - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: deepeval.md + filename: deepeval.md title: DeepEval - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/deepeval/pyproject.toml b/integrations/deepeval/pyproject.toml index d55bc1f28e..58a9a5e470 100644 --- a/integrations/deepeval/pyproject.toml +++ b/integrations/deepeval/pyproject.toml @@ -44,7 +44,7 @@ git_describe_command = 'git describe --tags --match="integrations/deepeval-v[0-9 installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/elasticsearch/pydoc/config_docusaurus.yml b/integrations/elasticsearch/pydoc/config_docusaurus.yml index f309dc2b69..4a6172059e 100644 --- a/integrations/elasticsearch/pydoc/config_docusaurus.yml +++ b/integrations/elasticsearch/pydoc/config_docusaurus.yml @@ -1,32 +1,17 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.elasticsearch.bm25_retriever - - haystack_integrations.components.retrievers.elasticsearch.embedding_retriever - - haystack_integrations.components.retrievers.elasticsearch.sql_retriever - - haystack_integrations.document_stores.elasticsearch.document_store - - haystack_integrations.document_stores.elasticsearch.filters - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.elasticsearch.bm25_retriever + - haystack_integrations.components.retrievers.elasticsearch.embedding_retriever + - haystack_integrations.components.retrievers.elasticsearch.sql_retriever + - haystack_integrations.document_stores.elasticsearch.document_store + - haystack_integrations.document_stores.elasticsearch.filters + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Elasticsearch integration for Haystack id: integrations-elasticsearch - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: elasticsearch.md + filename: elasticsearch.md title: Elasticsearch - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/elasticsearch/pyproject.toml b/integrations/elasticsearch/pyproject.toml index 75f9f07506..5147895926 100644 --- a/integrations/elasticsearch/pyproject.toml +++ b/integrations/elasticsearch/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/fastembed/pydoc/config_docusaurus.yml b/integrations/fastembed/pydoc/config_docusaurus.yml index b61886d433..58dfa42bca 100644 --- a/integrations/fastembed/pydoc/config_docusaurus.yml +++ b/integrations/fastembed/pydoc/config_docusaurus.yml @@ -1,32 +1,17 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.embedders.fastembed.fastembed_document_embedder - - haystack_integrations.components.embedders.fastembed.fastembed_text_embedder - - haystack_integrations.components.embedders.fastembed.fastembed_sparse_document_embedder - - haystack_integrations.components.embedders.fastembed.fastembed_sparse_text_embedder - - haystack_integrations.components.rankers.fastembed.ranker - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.embedders.fastembed.fastembed_document_embedder + - haystack_integrations.components.embedders.fastembed.fastembed_text_embedder + - haystack_integrations.components.embedders.fastembed.fastembed_sparse_document_embedder + - haystack_integrations.components.embedders.fastembed.fastembed_sparse_text_embedder + - haystack_integrations.components.rankers.fastembed.ranker + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: FastEmbed integration for Haystack id: fastembed-embedders - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: fastembed.md + filename: fastembed.md title: FastEmbed - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/fastembed/pyproject.toml b/integrations/fastembed/pyproject.toml index a17b9ae76a..0ce009db79 100644 --- a/integrations/fastembed/pyproject.toml +++ b/integrations/fastembed/pyproject.toml @@ -44,7 +44,7 @@ git_describe_command = 'git describe --tags --match="integrations/fastembed-v[0- installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/github/pydoc/config_docusaurus.yml b/integrations/github/pydoc/config_docusaurus.yml index f12a092f6a..808a32b6b8 100644 --- a/integrations/github/pydoc/config_docusaurus.yml +++ b/integrations/github/pydoc/config_docusaurus.yml @@ -1,33 +1,18 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.connectors.github.file_editor - - haystack_integrations.components.connectors.github.issue_commenter - - haystack_integrations.components.connectors.github.issue_viewer - - haystack_integrations.components.connectors.github.pr_creator - - haystack_integrations.components.connectors.github.repo_viewer - - haystack_integrations.components.connectors.github.repo_forker - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.connectors.github.file_editor + - haystack_integrations.components.connectors.github.issue_commenter + - haystack_integrations.components.connectors.github.issue_viewer + - haystack_integrations.components.connectors.github.pr_creator + - haystack_integrations.components.connectors.github.repo_viewer + - haystack_integrations.components.connectors.github.repo_forker + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: GitHub integration for Haystack id: integrations-github - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: github.md + filename: github.md title: GitHub - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/github/pyproject.toml b/integrations/github/pyproject.toml index 2e5fe7c1ff..2b8bf9d2a9 100644 --- a/integrations/github/pyproject.toml +++ b/integrations/github/pyproject.toml @@ -45,7 +45,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/google_ai/pydoc/config_docusaurus.yml b/integrations/google_ai/pydoc/config_docusaurus.yml index c753c18bfa..373bf79215 100644 --- a/integrations/google_ai/pydoc/config_docusaurus.yml +++ b/integrations/google_ai/pydoc/config_docusaurus.yml @@ -1,29 +1,14 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.google_ai.gemini - - haystack_integrations.components.generators.google_ai.chat.gemini - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.google_ai.gemini + - haystack_integrations.components.generators.google_ai.chat.gemini + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Google AI integration for Haystack id: integrations-google-ai - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: google_ai.md + filename: google_ai.md title: Google AI - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/google_ai/pyproject.toml b/integrations/google_ai/pyproject.toml index 9598368132..48031728f7 100644 --- a/integrations/google_ai/pyproject.toml +++ b/integrations/google_ai/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/google_genai/pydoc/config_docusaurus.yml b/integrations/google_genai/pydoc/config_docusaurus.yml index f6624f517f..db9db2f0e9 100644 --- a/integrations/google_genai/pydoc/config_docusaurus.yml +++ b/integrations/google_genai/pydoc/config_docusaurus.yml @@ -1,30 +1,15 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.google_genai.chat.chat_generator - - haystack_integrations.components.embedders.google_genai.document_embedder - - haystack_integrations.components.embedders.google_genai.text_embedder - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.google_genai.chat.chat_generator + - haystack_integrations.components.embedders.google_genai.document_embedder + - haystack_integrations.components.embedders.google_genai.text_embedder + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Google GenAI integration for Haystack id: integrations-google-genai - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: google_genai.md + filename: google_genai.md title: Google GenAI - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/google_genai/pyproject.toml b/integrations/google_genai/pyproject.toml index 5cacccc8c1..b1b16959fb 100644 --- a/integrations/google_genai/pyproject.toml +++ b/integrations/google_genai/pyproject.toml @@ -48,7 +48,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/google_vertex/pydoc/config_docusaurus.yml b/integrations/google_vertex/pydoc/config_docusaurus.yml index a98640091a..235b115302 100644 --- a/integrations/google_vertex/pydoc/config_docusaurus.yml +++ b/integrations/google_vertex/pydoc/config_docusaurus.yml @@ -1,36 +1,21 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.google_vertex.gemini - - haystack_integrations.components.generators.google_vertex.captioner - - haystack_integrations.components.generators.google_vertex.code_generator - - haystack_integrations.components.generators.google_vertex.image_generator - - haystack_integrations.components.generators.google_vertex.question_answering - - haystack_integrations.components.generators.google_vertex.text_generator - - haystack_integrations.components.generators.google_vertex.chat.gemini - - haystack_integrations.components.embedders.google_vertex.document_embedder - - haystack_integrations.components.embedders.google_vertex.text_embedder - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.google_vertex.gemini + - haystack_integrations.components.generators.google_vertex.captioner + - haystack_integrations.components.generators.google_vertex.code_generator + - haystack_integrations.components.generators.google_vertex.image_generator + - haystack_integrations.components.generators.google_vertex.question_answering + - haystack_integrations.components.generators.google_vertex.text_generator + - haystack_integrations.components.generators.google_vertex.chat.gemini + - haystack_integrations.components.embedders.google_vertex.document_embedder + - haystack_integrations.components.embedders.google_vertex.text_embedder + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Google Vertex integration for Haystack id: integrations-google-vertex - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: google_vertex.md + filename: google_vertex.md title: Google Vertex - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/google_vertex/pyproject.toml b/integrations/google_vertex/pyproject.toml index 49227c976b..6708300809 100644 --- a/integrations/google_vertex/pyproject.toml +++ b/integrations/google_vertex/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/hanlp/pydoc/config_docusaurus.yml b/integrations/hanlp/pydoc/config_docusaurus.yml index eaea9d609e..1cfd19c23b 100644 --- a/integrations/hanlp/pydoc/config_docusaurus.yml +++ b/integrations/hanlp/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.preprocessors.hanlp.chinese_document_splitter - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.preprocessors.hanlp.chinese_document_splitter + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: HanLP integration for Haystack id: integrations-hanlp - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: hanlp.md + filename: hanlp.md title: HanLP - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/hanlp/pyproject.toml b/integrations/hanlp/pyproject.toml index a0e272ea27..9c1bf42707 100644 --- a/integrations/hanlp/pyproject.toml +++ b/integrations/hanlp/pyproject.toml @@ -52,7 +52,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/jina/pydoc/config_docusaurus.yml b/integrations/jina/pydoc/config_docusaurus.yml index 022ed9ff49..f2cdc9d620 100644 --- a/integrations/jina/pydoc/config_docusaurus.yml +++ b/integrations/jina/pydoc/config_docusaurus.yml @@ -1,32 +1,17 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.embedders.jina.document_embedder - - haystack_integrations.components.embedders.jina.document_image_embedder - - haystack_integrations.components.embedders.jina.text_embedder - - haystack_integrations.components.rankers.jina.ranker - - haystack_integrations.components.connectors.jina.reader - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.embedders.jina.document_embedder + - haystack_integrations.components.embedders.jina.document_image_embedder + - haystack_integrations.components.embedders.jina.text_embedder + - haystack_integrations.components.rankers.jina.ranker + - haystack_integrations.components.connectors.jina.reader + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Jina integration for Haystack id: integrations-jina - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: jina.md + filename: jina.md title: Jina - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/jina/pyproject.toml b/integrations/jina/pyproject.toml index 1c8e24dcd9..71c7eb0e29 100644 --- a/integrations/jina/pyproject.toml +++ b/integrations/jina/pyproject.toml @@ -47,7 +47,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/langfuse/pydoc/config_docusaurus.yml b/integrations/langfuse/pydoc/config_docusaurus.yml index e532c46529..d52ab96039 100644 --- a/integrations/langfuse/pydoc/config_docusaurus.yml +++ b/integrations/langfuse/pydoc/config_docusaurus.yml @@ -1,29 +1,14 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.connectors.langfuse.langfuse_connector - - haystack_integrations.tracing.langfuse.tracer - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.connectors.langfuse.langfuse_connector + - haystack_integrations.tracing.langfuse.tracer + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Langfuse integration for Haystack id: integrations-langfuse - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: langfuse.md + filename: langfuse.md title: langfuse - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/langfuse/pyproject.toml b/integrations/langfuse/pyproject.toml index e4d4d7c65b..6ea35a4373 100644 --- a/integrations/langfuse/pyproject.toml +++ b/integrations/langfuse/pyproject.toml @@ -45,7 +45,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/llama_cpp/pydoc/config_docusaurus.yml b/integrations/llama_cpp/pydoc/config_docusaurus.yml index f5d2a2ab0e..8c5b447d58 100644 --- a/integrations/llama_cpp/pydoc/config_docusaurus.yml +++ b/integrations/llama_cpp/pydoc/config_docusaurus.yml @@ -1,29 +1,14 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.llama_cpp.generator - - haystack_integrations.components.generators.llama_cpp.chat.chat_generator - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.llama_cpp.generator + - haystack_integrations.components.generators.llama_cpp.chat.chat_generator + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Llama.cpp integration for Haystack id: integrations-llama-cpp - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: llama_cpp.md + filename: llama_cpp.md title: Llama.cpp - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/llama_cpp/pyproject.toml b/integrations/llama_cpp/pyproject.toml index 466da44b4a..9b7e395bad 100644 --- a/integrations/llama_cpp/pyproject.toml +++ b/integrations/llama_cpp/pyproject.toml @@ -55,7 +55,7 @@ git_describe_command = 'git describe --tags --match="integrations/llama_cpp-v[0- installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/llama_stack/pydoc/config_docusaurus.yml b/integrations/llama_stack/pydoc/config_docusaurus.yml index 1df6a9fd14..bd80c2c91f 100644 --- a/integrations/llama_stack/pydoc/config_docusaurus.yml +++ b/integrations/llama_stack/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.llama_stack.chat.chat_generator - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.llama_stack.chat.chat_generator + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Llama Stack integration for Haystack id: integrations-llama-stack - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: llama_stack.md + filename: llama_stack.md title: Llama Stack - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/llama_stack/pyproject.toml b/integrations/llama_stack/pyproject.toml index d811e1d412..109e02c961 100644 --- a/integrations/llama_stack/pyproject.toml +++ b/integrations/llama_stack/pyproject.toml @@ -42,7 +42,7 @@ git_describe_command = 'git describe --tags --match="integrations/llama_stack-v[ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/mcp/pydoc/config_docusaurus.yml b/integrations/mcp/pydoc/config_docusaurus.yml index aae9f71b87..842ca7d7ff 100644 --- a/integrations/mcp/pydoc/config_docusaurus.yml +++ b/integrations/mcp/pydoc/config_docusaurus.yml @@ -1,29 +1,14 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.tools.mcp.mcp_tool - - haystack_integrations.tools.mcp.mcp_toolset - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.tools.mcp.mcp_tool + - haystack_integrations.tools.mcp.mcp_toolset + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: MCP integration for Haystack id: integrations-mcp - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: mcp.md + filename: mcp.md title: MCP - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/mcp/pyproject.toml b/integrations/mcp/pyproject.toml index fc93403e64..8965906f3f 100644 --- a/integrations/mcp/pyproject.toml +++ b/integrations/mcp/pyproject.toml @@ -55,7 +55,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/mcp/src/haystack_integrations/tools/mcp/mcp_tool.py b/integrations/mcp/src/haystack_integrations/tools/mcp/mcp_tool.py index 986422ea47..731644d9a8 100644 --- a/integrations/mcp/src/haystack_integrations/tools/mcp/mcp_tool.py +++ b/integrations/mcp/src/haystack_integrations/tools/mcp/mcp_tool.py @@ -1238,7 +1238,7 @@ def from_dict(cls, data: dict[str, Any]) -> "Tool": :param data: Dictionary containing serialized tool data :returns: A fully initialized MCPTool instance - :raises Exception if connection fails + :raises Exception: if connection fails """ # Extract the tool parameters from the data dictionary inner_data = data["data"] diff --git a/integrations/meta_llama/pydoc/config_docusaurus.yml b/integrations/meta_llama/pydoc/config_docusaurus.yml index b5ed2d4f82..60553a7a29 100644 --- a/integrations/meta_llama/pydoc/config_docusaurus.yml +++ b/integrations/meta_llama/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.meta_llama.chat.chat_generator - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.meta_llama.chat.chat_generator + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Meta Llama API integration for Haystack id: integrations-meta-llama - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: meta_llama.md + filename: meta_llama.md title: Meta Llama API - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/meta_llama/pyproject.toml b/integrations/meta_llama/pyproject.toml index cd316b8161..4ae40fb0a6 100644 --- a/integrations/meta_llama/pyproject.toml +++ b/integrations/meta_llama/pyproject.toml @@ -44,7 +44,7 @@ git_describe_command = 'git describe --tags --match="integrations/meta_llama-v[0 installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/mistral/pydoc/config_docusaurus.yml b/integrations/mistral/pydoc/config_docusaurus.yml index 275c911e8e..c7cde19f2d 100644 --- a/integrations/mistral/pydoc/config_docusaurus.yml +++ b/integrations/mistral/pydoc/config_docusaurus.yml @@ -1,31 +1,16 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.embedders.mistral.document_embedder - - haystack_integrations.components.embedders.mistral.text_embedder - - haystack_integrations.components.generators.mistral.chat.chat_generator - - haystack_integrations.components.converters.mistral.ocr_document_converter - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.embedders.mistral.document_embedder + - haystack_integrations.components.embedders.mistral.text_embedder + - haystack_integrations.components.generators.mistral.chat.chat_generator + - haystack_integrations.components.converters.mistral.ocr_document_converter + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Mistral integration for Haystack id: integrations-mistral - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: mistral.md + filename: mistral.md title: Mistral - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/mistral/pyproject.toml b/integrations/mistral/pyproject.toml index 1328d26141..1992e2cb0e 100644 --- a/integrations/mistral/pyproject.toml +++ b/integrations/mistral/pyproject.toml @@ -45,7 +45,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/mongodb_atlas/pydoc/config_docusaurus.yml b/integrations/mongodb_atlas/pydoc/config_docusaurus.yml index ffa92e09eb..c688b8c7da 100644 --- a/integrations/mongodb_atlas/pydoc/config_docusaurus.yml +++ b/integrations/mongodb_atlas/pydoc/config_docusaurus.yml @@ -1,31 +1,16 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.document_stores.mongodb_atlas.document_store - - haystack_integrations.document_stores.mongodb_atlas.filters - - haystack_integrations.components.retrievers.mongodb_atlas.embedding_retriever - - haystack_integrations.components.retrievers.mongodb_atlas.full_text_retriever - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.document_stores.mongodb_atlas.document_store + - haystack_integrations.document_stores.mongodb_atlas.filters + - haystack_integrations.components.retrievers.mongodb_atlas.embedding_retriever + - haystack_integrations.components.retrievers.mongodb_atlas.full_text_retriever + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: MongoDB Atlas integration for Haystack id: integrations-mongodb-atlas - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: mongodb_atlas.md + filename: mongodb_atlas.md title: MongoDB Atlas - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/mongodb_atlas/pyproject.toml b/integrations/mongodb_atlas/pyproject.toml index 93172463de..0eaf11e81f 100644 --- a/integrations/mongodb_atlas/pyproject.toml +++ b/integrations/mongodb_atlas/pyproject.toml @@ -48,7 +48,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/nvidia/pydoc/config_docusaurus.yml b/integrations/nvidia/pydoc/config_docusaurus.yml index 4a36094732..74a2c91250 100644 --- a/integrations/nvidia/pydoc/config_docusaurus.yml +++ b/integrations/nvidia/pydoc/config_docusaurus.yml @@ -1,34 +1,19 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.embedders.nvidia.document_embedder - - haystack_integrations.components.embedders.nvidia.text_embedder - - haystack_integrations.components.embedders.nvidia.truncate - - haystack_integrations.components.generators.nvidia.generator - - haystack_integrations.components.generators.nvidia.chat.chat_generator - - haystack_integrations.components.rankers.nvidia.ranker - - haystack_integrations.components.rankers.nvidia.truncate - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.embedders.nvidia.document_embedder + - haystack_integrations.components.embedders.nvidia.text_embedder + - haystack_integrations.components.embedders.nvidia.truncate + - haystack_integrations.components.generators.nvidia.generator + - haystack_integrations.components.generators.nvidia.chat.chat_generator + - haystack_integrations.components.rankers.nvidia.ranker + - haystack_integrations.components.rankers.nvidia.truncate + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Nvidia integration for Haystack id: integrations-nvidia - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: nvidia.md + filename: nvidia.md title: Nvidia - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/nvidia/pyproject.toml b/integrations/nvidia/pyproject.toml index edaee07d20..61c3ab853e 100644 --- a/integrations/nvidia/pyproject.toml +++ b/integrations/nvidia/pyproject.toml @@ -45,7 +45,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/ollama/pydoc/config_docusaurus.yml b/integrations/ollama/pydoc/config_docusaurus.yml index b68a10dd65..c71ed8fc72 100644 --- a/integrations/ollama/pydoc/config_docusaurus.yml +++ b/integrations/ollama/pydoc/config_docusaurus.yml @@ -1,31 +1,16 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.ollama.generator - - haystack_integrations.components.generators.ollama.chat.chat_generator - - haystack_integrations.components.embedders.ollama.document_embedder - - haystack_integrations.components.embedders.ollama.text_embedder - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.ollama.generator + - haystack_integrations.components.generators.ollama.chat.chat_generator + - haystack_integrations.components.embedders.ollama.document_embedder + - haystack_integrations.components.embedders.ollama.text_embedder + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Ollama integration for Haystack id: integrations-ollama - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: ollama.md + filename: ollama.md title: Ollama - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/ollama/pyproject.toml b/integrations/ollama/pyproject.toml index 5ad356ae02..ad7942ac50 100644 --- a/integrations/ollama/pyproject.toml +++ b/integrations/ollama/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/openrouter/pydoc/config_docusaurus.yml b/integrations/openrouter/pydoc/config_docusaurus.yml index 0535e92194..f590e299af 100644 --- a/integrations/openrouter/pydoc/config_docusaurus.yml +++ b/integrations/openrouter/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.openrouter.chat.chat_generator - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.openrouter.chat.chat_generator + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: OpenRouter integration for Haystack id: integrations-openrouter - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: openrouter.md + filename: openrouter.md title: OpenRouter - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/openrouter/pyproject.toml b/integrations/openrouter/pyproject.toml index d151383118..cab3a665ae 100644 --- a/integrations/openrouter/pyproject.toml +++ b/integrations/openrouter/pyproject.toml @@ -44,7 +44,7 @@ git_describe_command = 'git describe --tags --match="integrations/openrouter-v[0 installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/opensearch/pydoc/config_docusaurus.yml b/integrations/opensearch/pydoc/config_docusaurus.yml index 321c37c9e9..625bd9fd8e 100644 --- a/integrations/opensearch/pydoc/config_docusaurus.yml +++ b/integrations/opensearch/pydoc/config_docusaurus.yml @@ -1,34 +1,19 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.opensearch.bm25_retriever - - haystack_integrations.components.retrievers.opensearch.embedding_retriever - - haystack_integrations.components.retrievers.opensearch.metadata_retriever - - haystack_integrations.components.retrievers.opensearch.open_search_hybrid_retriever - - haystack_integrations.components.retrievers.opensearch.sql_retriever - - haystack_integrations.document_stores.opensearch.document_store - - haystack_integrations.document_stores.opensearch.filters - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.opensearch.bm25_retriever + - haystack_integrations.components.retrievers.opensearch.embedding_retriever + - haystack_integrations.components.retrievers.opensearch.metadata_retriever + - haystack_integrations.components.retrievers.opensearch.open_search_hybrid_retriever + - haystack_integrations.components.retrievers.opensearch.sql_retriever + - haystack_integrations.document_stores.opensearch.document_store + - haystack_integrations.document_stores.opensearch.filters + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: OpenSearch integration for Haystack id: integrations-opensearch - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: opensearch.md + filename: opensearch.md title: OpenSearch - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/opensearch/pyproject.toml b/integrations/opensearch/pyproject.toml index 3cf9940115..2968f6e7e7 100644 --- a/integrations/opensearch/pyproject.toml +++ b/integrations/opensearch/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/optimum/pydoc/config_docusaurus.yml b/integrations/optimum/pydoc/config_docusaurus.yml index d96df3a070..f3b86c9f51 100644 --- a/integrations/optimum/pydoc/config_docusaurus.yml +++ b/integrations/optimum/pydoc/config_docusaurus.yml @@ -1,32 +1,17 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.embedders.optimum.optimum_document_embedder - - haystack_integrations.components.embedders.optimum.optimum_text_embedder - - haystack_integrations.components.embedders.optimum.pooling - - haystack_integrations.components.embedders.optimum.optimization - - haystack_integrations.components.embedders.optimum.quantization - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.embedders.optimum.optimum_document_embedder + - haystack_integrations.components.embedders.optimum.optimum_text_embedder + - haystack_integrations.components.embedders.optimum.pooling + - haystack_integrations.components.embedders.optimum.optimization + - haystack_integrations.components.embedders.optimum.quantization + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Optimum integration for Haystack id: integrations-optimum - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: optimum.md + filename: optimum.md title: Optimum - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/optimum/pyproject.toml b/integrations/optimum/pyproject.toml index 4d7a45e6f8..c5ea29aefd 100644 --- a/integrations/optimum/pyproject.toml +++ b/integrations/optimum/pyproject.toml @@ -58,7 +58,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/paddleocr/pydoc/config_docusaurus.yml b/integrations/paddleocr/pydoc/config_docusaurus.yml index 75c6c7e287..1f17dbe5f4 100644 --- a/integrations/paddleocr/pydoc/config_docusaurus.yml +++ b/integrations/paddleocr/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.converters.paddleocr.paddleocr_vl_document_converter - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.converters.paddleocr.paddleocr_vl_document_converter + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: PaddleOCR integration for Haystack id: integrations-paddleocr - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: paddleocr.md + filename: paddleocr.md title: PaddleOCR - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/paddleocr/pyproject.toml b/integrations/paddleocr/pyproject.toml index 80b7e1bf5c..fbc21c2661 100644 --- a/integrations/paddleocr/pyproject.toml +++ b/integrations/paddleocr/pyproject.toml @@ -50,7 +50,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/pgvector/pydoc/config_docusaurus.yml b/integrations/pgvector/pydoc/config_docusaurus.yml index 22cbfdf3f4..21b8f1027f 100644 --- a/integrations/pgvector/pydoc/config_docusaurus.yml +++ b/integrations/pgvector/pydoc/config_docusaurus.yml @@ -1,30 +1,15 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.pgvector.embedding_retriever - - haystack_integrations.components.retrievers.pgvector.keyword_retriever - - haystack_integrations.document_stores.pgvector.document_store - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.pgvector.embedding_retriever + - haystack_integrations.components.retrievers.pgvector.keyword_retriever + - haystack_integrations.document_stores.pgvector.document_store + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Pgvector integration for Haystack id: integrations-pgvector - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: pgvector.md + filename: pgvector.md title: Pgvector - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/pgvector/pyproject.toml b/integrations/pgvector/pyproject.toml index 3dbd0d5e04..f8e8995ed1 100644 --- a/integrations/pgvector/pyproject.toml +++ b/integrations/pgvector/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/pinecone/pydoc/config_docusaurus.yml b/integrations/pinecone/pydoc/config_docusaurus.yml index 22e0f4ba69..1c328cfe54 100644 --- a/integrations/pinecone/pydoc/config_docusaurus.yml +++ b/integrations/pinecone/pydoc/config_docusaurus.yml @@ -1,29 +1,14 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.pinecone.embedding_retriever - - haystack_integrations.document_stores.pinecone.document_store - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.pinecone.embedding_retriever + - haystack_integrations.document_stores.pinecone.document_store + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Pinecone integration for Haystack id: integrations-pinecone - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: pinecone.md + filename: pinecone.md title: Pinecone - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/pinecone/pyproject.toml b/integrations/pinecone/pyproject.toml index 56900f1e9e..32878c698e 100644 --- a/integrations/pinecone/pyproject.toml +++ b/integrations/pinecone/pyproject.toml @@ -48,7 +48,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/qdrant/pydoc/config_docusaurus.yml b/integrations/qdrant/pydoc/config_docusaurus.yml index 67ee3f5ae7..2ca60e5d37 100644 --- a/integrations/qdrant/pydoc/config_docusaurus.yml +++ b/integrations/qdrant/pydoc/config_docusaurus.yml @@ -1,30 +1,15 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.qdrant.retriever - - haystack_integrations.document_stores.qdrant.document_store - - haystack_integrations.document_stores.qdrant.migrate_to_sparse - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.qdrant.retriever + - haystack_integrations.document_stores.qdrant.document_store + - haystack_integrations.document_stores.qdrant.migrate_to_sparse + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Qdrant integration for Haystack id: integrations-qdrant - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: qdrant.md + filename: qdrant.md title: Qdrant - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/qdrant/pyproject.toml b/integrations/qdrant/pyproject.toml index acbff15a4c..bbe4db51e4 100644 --- a/integrations/qdrant/pyproject.toml +++ b/integrations/qdrant/pyproject.toml @@ -51,7 +51,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/ragas/pydoc/config_docusaurus.yml b/integrations/ragas/pydoc/config_docusaurus.yml index 69366d5d4f..6422b34fa8 100644 --- a/integrations/ragas/pydoc/config_docusaurus.yml +++ b/integrations/ragas/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.evaluators.ragas.evaluator - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.evaluators.ragas.evaluator + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Ragas integration for Haystack id: integrations-ragas - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: ragas.md + filename: ragas.md title: Ragas - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/ragas/pyproject.toml b/integrations/ragas/pyproject.toml index 12e3f147ae..609e097edf 100644 --- a/integrations/ragas/pyproject.toml +++ b/integrations/ragas/pyproject.toml @@ -45,7 +45,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/snowflake/pydoc/config_docusaurus.yml b/integrations/snowflake/pydoc/config_docusaurus.yml index 8dca4d4c44..cb7c4f567d 100644 --- a/integrations/snowflake/pydoc/config_docusaurus.yml +++ b/integrations/snowflake/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.snowflake.snowflake_table_retriever - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.snowflake.snowflake_table_retriever + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Snowflake integration for Haystack id: integrations-snowflake - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: snowflake.md + filename: snowflake.md title: Snowflake - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/snowflake/pyproject.toml b/integrations/snowflake/pyproject.toml index 8e8184dff9..777c502639 100644 --- a/integrations/snowflake/pyproject.toml +++ b/integrations/snowflake/pyproject.toml @@ -51,7 +51,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/stackit/pydoc/config_docusaurus.yml b/integrations/stackit/pydoc/config_docusaurus.yml index eaecc14e12..469ec2f144 100644 --- a/integrations/stackit/pydoc/config_docusaurus.yml +++ b/integrations/stackit/pydoc/config_docusaurus.yml @@ -1,30 +1,15 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.stackit.chat.chat_generator - - haystack_integrations.components.embedders.stackit.document_embedder - - haystack_integrations.components.embedders.stackit.text_embedder - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.stackit.chat.chat_generator + - haystack_integrations.components.embedders.stackit.document_embedder + - haystack_integrations.components.embedders.stackit.text_embedder + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: STACKIT integration for Haystack id: integrations-stackit - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: stackit.md + filename: stackit.md title: STACKIT - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/stackit/pyproject.toml b/integrations/stackit/pyproject.toml index f07850836e..523130a1d2 100644 --- a/integrations/stackit/pyproject.toml +++ b/integrations/stackit/pyproject.toml @@ -44,7 +44,7 @@ git_describe_command = 'git describe --tags --match="integrations/stackit-v[0-9] installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/togetherai/pydoc/config_docusaurus.yml b/integrations/togetherai/pydoc/config_docusaurus.yml index ad1e2a60b4..f020a9e22f 100644 --- a/integrations/togetherai/pydoc/config_docusaurus.yml +++ b/integrations/togetherai/pydoc/config_docusaurus.yml @@ -1,29 +1,14 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.togetherai.generator - - haystack_integrations.components.generators.togetherai.chat.chat_generator - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.togetherai.generator + - haystack_integrations.components.generators.togetherai.chat.chat_generator + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Together AI integration for Haystack id: integrations-togetherai - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: togetherai.md + filename: togetherai.md title: Together AI - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/togetherai/pyproject.toml b/integrations/togetherai/pyproject.toml index c85651bc8c..920adde974 100644 --- a/integrations/togetherai/pyproject.toml +++ b/integrations/togetherai/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/unstructured/pydoc/config_docusaurus.yml b/integrations/unstructured/pydoc/config_docusaurus.yml index e35b5f6bfc..7a56cda753 100644 --- a/integrations/unstructured/pydoc/config_docusaurus.yml +++ b/integrations/unstructured/pydoc/config_docusaurus.yml @@ -1,28 +1,13 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.converters.unstructured.converter - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.converters.unstructured.converter + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Unstructured integration for Haystack id: integrations-unstructured - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: unstructured.md + filename: unstructured.md title: Unstructured - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/unstructured/pyproject.toml b/integrations/unstructured/pyproject.toml index bce176d259..0b0766e18b 100644 --- a/integrations/unstructured/pyproject.toml +++ b/integrations/unstructured/pyproject.toml @@ -50,7 +50,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/valkey/pydoc/config_docusaurus.yml b/integrations/valkey/pydoc/config_docusaurus.yml index 5e9ab30ac0..d6230a6fa5 100644 --- a/integrations/valkey/pydoc/config_docusaurus.yml +++ b/integrations/valkey/pydoc/config_docusaurus.yml @@ -1,30 +1,15 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.retrievers.valkey.embedding_retriever - - haystack_integrations.document_stores.valkey.document_store - - haystack_integrations.document_stores.valkey.filters - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.retrievers.valkey.embedding_retriever + - haystack_integrations.document_stores.valkey.document_store + - haystack_integrations.document_stores.valkey.filters + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Valkey integration for Haystack id: integrations-valkey - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: valkey.md + filename: valkey.md title: Valkey - type: haystack_pydoc_tools.renderers.DocusaurusRenderer \ No newline at end of file diff --git a/integrations/valkey/pyproject.toml b/integrations/valkey/pyproject.toml index bfc0b2bc79..c12d29f888 100644 --- a/integrations/valkey/pyproject.toml +++ b/integrations/valkey/pyproject.toml @@ -48,7 +48,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args} && ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/watsonx/pydoc/config_docusaurus.yml b/integrations/watsonx/pydoc/config_docusaurus.yml index 37b0666e68..11faa6f1c1 100644 --- a/integrations/watsonx/pydoc/config_docusaurus.yml +++ b/integrations/watsonx/pydoc/config_docusaurus.yml @@ -1,31 +1,16 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.generators.watsonx.generator - - haystack_integrations.components.generators.watsonx.chat.chat_generator - - haystack_integrations.components.embedders.watsonx.document_embedder - - haystack_integrations.components.embedders.watsonx.text_embedder - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.generators.watsonx.generator + - haystack_integrations.components.generators.watsonx.chat.chat_generator + - haystack_integrations.components.embedders.watsonx.document_embedder + - haystack_integrations.components.embedders.watsonx.text_embedder + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: IBM watsonx.ai integration for Haystack id: integrations-watsonx - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: watsonx.md + filename: watsonx.md title: IBM watsonx.ai - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/watsonx/pyproject.toml b/integrations/watsonx/pyproject.toml index 72d410660c..4a56f31da9 100644 --- a/integrations/watsonx/pyproject.toml +++ b/integrations/watsonx/pyproject.toml @@ -48,7 +48,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/weave/pydoc/config_docusaurus.yml b/integrations/weave/pydoc/config_docusaurus.yml index 1a1268ab4e..9d97380398 100644 --- a/integrations/weave/pydoc/config_docusaurus.yml +++ b/integrations/weave/pydoc/config_docusaurus.yml @@ -1,29 +1,14 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.components.connectors.weave.weave_connector - - haystack_integrations.tracing.weave.tracer - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.components.connectors.weave.weave_connector + - haystack_integrations.tracing.weave.tracer + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Weights & Bias integration for Haystack id: integrations-weave - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: weave.md + filename: weave.md title: Weave - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/weave/pyproject.toml b/integrations/weave/pyproject.toml index 6705e75690..2582cc18d6 100644 --- a/integrations/weave/pyproject.toml +++ b/integrations/weave/pyproject.toml @@ -44,7 +44,7 @@ git_describe_command = 'git describe --tags --match="integrations/weave-v[0-9]*" installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}" diff --git a/integrations/weaviate/pydoc/config_docusaurus.yml b/integrations/weaviate/pydoc/config_docusaurus.yml index e5ea3dac23..9cb46fd14b 100644 --- a/integrations/weaviate/pydoc/config_docusaurus.yml +++ b/integrations/weaviate/pydoc/config_docusaurus.yml @@ -1,32 +1,17 @@ loaders: -- ignore_when_discovered: - - __init__ - modules: - - haystack_integrations.document_stores.weaviate.auth - - haystack_integrations.document_stores.weaviate.document_store - - haystack_integrations.components.retrievers.weaviate.bm25_retriever - - haystack_integrations.components.retrievers.weaviate.embedding_retriever - - haystack_integrations.components.retrievers.weaviate.hybrid_retriever - search_path: - - ../src - type: haystack_pydoc_tools.loaders.CustomPythonLoader + - modules: + - haystack_integrations.document_stores.weaviate.auth + - haystack_integrations.document_stores.weaviate.document_store + - haystack_integrations.components.retrievers.weaviate.bm25_retriever + - haystack_integrations.components.retrievers.weaviate.embedding_retriever + - haystack_integrations.components.retrievers.weaviate.hybrid_retriever + search_path: [../src] processors: -- do_not_filter_modules: false - documented_only: true - expression: null - skip_empty_modules: true - type: filter -- type: smart -- type: crossref + - type: filter + documented_only: true + skip_empty_modules: true renderer: description: Weaviate integration for Haystack id: integrations-weaviate - markdown: - add_member_class_prefix: false - add_method_class_prefix: true - classdef_code_block: false - descriptive_class_title: false - descriptive_module_title: true - filename: weaviate.md + filename: weaviate.md title: Weaviate - type: haystack_pydoc_tools.renderers.DocusaurusRenderer diff --git a/integrations/weaviate/pyproject.toml b/integrations/weaviate/pyproject.toml index f27c8435d4..810dbdfcaf 100644 --- a/integrations/weaviate/pyproject.toml +++ b/integrations/weaviate/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] +docs = ["haystack-pydoc pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args}; ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}"