From 8deca72d97e7a66427aa6d9427442269f2874afd Mon Sep 17 00:00:00 2001 From: anakin87 Date: Thu, 27 Nov 2025 11:22:20 +0100 Subject: [PATCH] chore: remove Readme API CI workflow and configs --- .github/workflows/CI_docusaurus_sync.yml | 8 +- .github/workflows/CI_readme_sync.yml | 86 ------------------- .github/workflows/anthropic.yml | 4 + integrations/aimlapi/pydoc/config.yml | 29 ------- integrations/aimlapi/pyproject.toml | 2 +- integrations/amazon_bedrock/pydoc/config.yml | 42 --------- integrations/amazon_bedrock/pyproject.toml | 2 +- .../amazon_sagemaker/pydoc/config.yml | 29 ------- integrations/amazon_sagemaker/pyproject.toml | 2 +- integrations/anthropic/pydoc/config.yml | 30 ------- integrations/anthropic/pyproject.toml | 2 +- integrations/astra/pydoc/config.yml | 31 ------- integrations/astra/pyproject.toml | 2 +- integrations/azure_ai_search/pydoc/config.yml | 31 ------- integrations/azure_ai_search/pyproject.toml | 2 +- integrations/chroma/pydoc/config.yml | 32 ------- integrations/chroma/pyproject.toml | 2 +- integrations/cohere/pydoc/config.yml | 35 -------- integrations/cohere/pyproject.toml | 2 +- integrations/cometapi/pydoc/config.yml | 29 ------- integrations/cometapi/pyproject.toml | 2 +- integrations/deepeval/pydoc/config.yml | 33 ------- integrations/deepeval/pyproject.toml | 2 +- integrations/elasticsearch/pydoc/config.yml | 32 ------- integrations/elasticsearch/pyproject.toml | 2 +- integrations/fastembed/pydoc/config.yml | 34 -------- integrations/fastembed/pyproject.toml | 2 +- integrations/github/pydoc/config.yml | 34 -------- integrations/github/pyproject.toml | 2 +- integrations/google_ai/pydoc/config.yml | 30 ------- integrations/google_ai/pyproject.toml | 2 +- integrations/google_genai/pydoc/config.yml | 31 ------- integrations/google_genai/pyproject.toml | 2 +- integrations/google_vertex/pydoc/config.yml | 37 -------- integrations/google_vertex/pyproject.toml | 2 +- integrations/hanlp/pydoc/config.yml | 29 ------- integrations/hanlp/pyproject.toml | 2 +- integrations/jina/pydoc/config.yml | 34 -------- integrations/jina/pyproject.toml | 2 +- integrations/langfuse/pydoc/config.yml | 30 ------- integrations/langfuse/pyproject.toml | 2 +- integrations/llama_cpp/pydoc/config.yml | 29 ------- integrations/llama_cpp/pyproject.toml | 2 +- integrations/llama_stack/pydoc/config.yml | 29 ------- integrations/llama_stack/pyproject.toml | 2 +- integrations/mcp/pydoc/config.yml | 30 ------- integrations/mcp/pyproject.toml | 2 +- integrations/meta_llama/pydoc/config.yml | 29 ------- integrations/meta_llama/pyproject.toml | 2 +- integrations/mistral/pydoc/config.yml | 32 ------- integrations/mistral/pyproject.toml | 2 +- integrations/mongodb_atlas/pydoc/config.yml | 32 ------- integrations/mongodb_atlas/pyproject.toml | 2 +- integrations/nvidia/pydoc/config.yml | 36 -------- integrations/nvidia/pyproject.toml | 2 +- integrations/ollama/pydoc/config.yml | 32 ------- integrations/ollama/pyproject.toml | 2 +- integrations/openrouter/pydoc/config.yml | 29 ------- integrations/openrouter/pyproject.toml | 2 +- integrations/opensearch/pydoc/config.yml | 33 ------- integrations/opensearch/pyproject.toml | 2 +- integrations/optimum/pydoc/config.yml | 34 -------- integrations/optimum/pyproject.toml | 2 +- integrations/pgvector/pydoc/config.yml | 31 ------- integrations/pgvector/pyproject.toml | 2 +- integrations/pinecone/pydoc/config.yml | 31 ------- integrations/pinecone/pyproject.toml | 2 +- integrations/qdrant/pydoc/config.yml | 32 ------- integrations/qdrant/pyproject.toml | 2 +- integrations/ragas/pydoc/config.yml | 30 ------- integrations/ragas/pyproject.toml | 2 +- integrations/snowflake/pydoc/config.yml | 30 ------- integrations/snowflake/pyproject.toml | 2 +- integrations/stackit/pydoc/config.yml | 31 ------- integrations/stackit/pyproject.toml | 2 +- integrations/togetherai/pydoc/config.yml | 30 ------- integrations/togetherai/pyproject.toml | 2 +- integrations/unstructured/pydoc/config.yml | 29 ------- integrations/unstructured/pyproject.toml | 2 +- integrations/watsonx/pydoc/config.yml | 32 ------- integrations/watsonx/pyproject.toml | 2 +- integrations/weaviate/pydoc/config.yml | 34 -------- integrations/weaviate/pyproject.toml | 2 +- .../weights_and_biases_weave/pydoc/config.yml | 30 ------- .../weights_and_biases_weave/pyproject.toml | 2 +- 85 files changed, 48 insertions(+), 1429 deletions(-) delete mode 100644 .github/workflows/CI_readme_sync.yml delete mode 100644 integrations/aimlapi/pydoc/config.yml delete mode 100644 integrations/amazon_bedrock/pydoc/config.yml delete mode 100644 integrations/amazon_sagemaker/pydoc/config.yml delete mode 100644 integrations/anthropic/pydoc/config.yml delete mode 100644 integrations/astra/pydoc/config.yml delete mode 100644 integrations/azure_ai_search/pydoc/config.yml delete mode 100644 integrations/chroma/pydoc/config.yml delete mode 100644 integrations/cohere/pydoc/config.yml delete mode 100644 integrations/cometapi/pydoc/config.yml delete mode 100644 integrations/deepeval/pydoc/config.yml delete mode 100644 integrations/elasticsearch/pydoc/config.yml delete mode 100644 integrations/fastembed/pydoc/config.yml delete mode 100644 integrations/github/pydoc/config.yml delete mode 100644 integrations/google_ai/pydoc/config.yml delete mode 100644 integrations/google_genai/pydoc/config.yml delete mode 100644 integrations/google_vertex/pydoc/config.yml delete mode 100644 integrations/hanlp/pydoc/config.yml delete mode 100644 integrations/jina/pydoc/config.yml delete mode 100644 integrations/langfuse/pydoc/config.yml delete mode 100644 integrations/llama_cpp/pydoc/config.yml delete mode 100644 integrations/llama_stack/pydoc/config.yml delete mode 100644 integrations/mcp/pydoc/config.yml delete mode 100644 integrations/meta_llama/pydoc/config.yml delete mode 100644 integrations/mistral/pydoc/config.yml delete mode 100644 integrations/mongodb_atlas/pydoc/config.yml delete mode 100644 integrations/nvidia/pydoc/config.yml delete mode 100644 integrations/ollama/pydoc/config.yml delete mode 100644 integrations/openrouter/pydoc/config.yml delete mode 100644 integrations/opensearch/pydoc/config.yml delete mode 100644 integrations/optimum/pydoc/config.yml delete mode 100644 integrations/pgvector/pydoc/config.yml delete mode 100644 integrations/pinecone/pydoc/config.yml delete mode 100644 integrations/qdrant/pydoc/config.yml delete mode 100644 integrations/ragas/pydoc/config.yml delete mode 100644 integrations/snowflake/pydoc/config.yml delete mode 100644 integrations/stackit/pydoc/config.yml delete mode 100644 integrations/togetherai/pydoc/config.yml delete mode 100644 integrations/unstructured/pydoc/config.yml delete mode 100644 integrations/watsonx/pydoc/config.yml delete mode 100644 integrations/weaviate/pydoc/config.yml delete mode 100644 integrations/weights_and_biases_weave/pydoc/config.yml diff --git a/.github/workflows/CI_docusaurus_sync.yml b/.github/workflows/CI_docusaurus_sync.yml index da7dd28d42..d458e1bbd4 100644 --- a/.github/workflows/CI_docusaurus_sync.yml +++ b/.github/workflows/CI_docusaurus_sync.yml @@ -31,10 +31,8 @@ jobs: with: python-version: "3.10" - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install -U haystack-pydoc-tools + - name: Install Hatch + run: pip install --upgrade hatch - name: Get project folder id: pathfinder @@ -50,7 +48,7 @@ jobs: - name: Generate API reference working-directory: ${{ steps.pathfinder.outputs.project_path }} - run: pydoc-markdown pydoc/config_docusaurus.yml + run: hatch run docs - name: Upload API reference artifact uses: actions/upload-artifact@v5 diff --git a/.github/workflows/CI_readme_sync.yml b/.github/workflows/CI_readme_sync.yml deleted file mode 100644 index 23663bd67e..0000000000 --- a/.github/workflows/CI_readme_sync.yml +++ /dev/null @@ -1,86 +0,0 @@ -name: Core / Sync docs with Readme - -on: - push: - tags: - - "**-v[0-9].[0-9]+.[0-9]+" - - workflow_dispatch: # Activate this workflow manually - inputs: - tag: - description: "Tag with this format: integrations/-v1.0.0" - required: true - type: string - default: integrations/-v1.0.0 - -env: - TAG: ${{ inputs.tag || github.ref_name }} - -jobs: - get-versions: - runs-on: ubuntu-latest - outputs: - versions: ${{ steps.version_finder.outputs.versions }} - steps: - - name: Get Haystack Docs versions - id: version_finder - run: | - curl -s https://dash.readme.com/api/v1/version --header 'authorization: Basic ${{ secrets.README_API_KEY }}' > out - VERSIONS=$(jq '[ .[] | select(.version | startswith("2."))| .version ]' out) - { - echo 'versions<> "$GITHUB_OUTPUT" - - sync: - runs-on: ubuntu-latest - needs: get-versions - strategy: - fail-fast: false - max-parallel: 1 - matrix: - hs-docs-version: ${{ fromJSON(needs.get-versions.outputs.versions) }} - steps: - - name: Checkout this repo - uses: actions/checkout@v6 - - - name: Set up Python - uses: actions/setup-python@v6 - with: - python-version: "3.10" - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install -U haystack-pydoc-tools hatch "click<8.3.0" - - - name: Get project folder - id: pathfinder - shell: python - run: | - import os - project_path = os.environ["TAG"].rsplit("-", maxsplit=1)[0] - with open(os.environ['GITHUB_OUTPUT'], 'a') as f: - print(f'project_path={project_path}', file=f) - - - name: Generate docs - working-directory: ${{ steps.pathfinder.outputs.project_path }} - env: - # This is necessary to fetch the documentation categories - # from Readme.io as we need them to associate the slug - # in config files with their id. - README_API_KEY: ${{ secrets.README_API_KEY }} - # The same category has a different id on different readme docs versions. - # This is the docs version on readme that we'll use to get the category id. - PYDOC_TOOLS_HAYSTACK_DOC_VERSION: ${{ matrix.hs-docs-version }} - run: | - hatch run docs - mkdir tmp - find . -name "_readme_*.md" -exec cp "{}" tmp \; - ls tmp - - - name: Sync API docs with Haystack docs version ${{ matrix.hs-docs-version }} - uses: readmeio/rdme@v9 - with: - rdme: docs ${{ steps.pathfinder.outputs.project_path }}/tmp --key=${{ secrets.README_API_KEY }} --version=${{ matrix.hs-docs-version }} diff --git a/.github/workflows/anthropic.yml b/.github/workflows/anthropic.yml index 2593c2a03c..6d89bb2918 100644 --- a/.github/workflows/anthropic.yml +++ b/.github/workflows/anthropic.yml @@ -54,6 +54,10 @@ jobs: if: matrix.python-version == '3.9' && runner.os == 'Linux' run: hatch run fmt-check && hatch run test:types + - name: Generate docs + if: matrix.python-version == '3.9' && runner.os == 'Linux' + run: hatch run docs + - name: Run tests run: hatch run test:cov-retry diff --git a/integrations/aimlapi/pydoc/config.yml b/integrations/aimlapi/pydoc/config.yml deleted file mode 100644 index cd66f32c0f..0000000000 --- a/integrations/aimlapi/pydoc/config.yml +++ /dev/null @@ -1,29 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.aimlapi.chat.chat_generator", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: AIMLAPI integration for Haystack - category_slug: integrations-api - title: AIMLAPI - slug: integrations-aimlapi - order: 200 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_aimlapi.md \ No newline at end of file diff --git a/integrations/aimlapi/pyproject.toml b/integrations/aimlapi/pyproject.toml index 3c5f00c840..7bb3b794a4 100644 --- a/integrations/aimlapi/pyproject.toml +++ b/integrations/aimlapi/pyproject.toml @@ -45,7 +45,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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/amazon_bedrock/pydoc/config.yml deleted file mode 100644 index 77f072266e..0000000000 --- a/integrations/amazon_bedrock/pydoc/config.yml +++ /dev/null @@ -1,42 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: filter - expression: "name not in ['BedrockRanker']" - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Amazon Bedrock integration for Haystack - category_slug: integrations-api - title: Amazon Bedrock - slug: integrations-amazon-bedrock - order: 9 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_amazon_bedrock.md diff --git a/integrations/amazon_bedrock/pyproject.toml b/integrations/amazon_bedrock/pyproject.toml index 5ef8ac7586..271637e036 100644 --- a/integrations/amazon_bedrock/pyproject.toml +++ b/integrations/amazon_bedrock/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/amazon_sagemaker/pydoc/config.yml deleted file mode 100644 index 950e949f7a..0000000000 --- a/integrations/amazon_sagemaker/pydoc/config.yml +++ /dev/null @@ -1,29 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.amazon_sagemaker.sagemaker", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Amazon Sagemaker integration for Haystack - category_slug: integrations-api - title: Amazon Sagemaker - slug: integrations-amazon-sagemaker - order: 20 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_amazon_sagemaker.md diff --git a/integrations/amazon_sagemaker/pyproject.toml b/integrations/amazon_sagemaker/pyproject.toml index aaca6c0ba9..287dc0eb89 100644 --- a/integrations/amazon_sagemaker/pyproject.toml +++ b/integrations/amazon_sagemaker/pyproject.toml @@ -48,7 +48,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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/anthropic/pydoc/config.yml deleted file mode 100644 index bd38115715..0000000000 --- a/integrations/anthropic/pydoc/config.yml +++ /dev/null @@ -1,30 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.anthropic.generator", - "haystack_integrations.components.generators.anthropic.chat.chat_generator", - "haystack_integrations.components.generators.anthropic.chat.vertex_chat_generator", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Anthropic integration for Haystack - category_slug: integrations-api - title: Anthropic - slug: integrations-anthropic - order: 23 - markdown: - descriptive_class_title: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_anthropic.md diff --git a/integrations/anthropic/pyproject.toml b/integrations/anthropic/pyproject.toml index c2d3dcd690..332c678223 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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/astra/pydoc/config.yml deleted file mode 100644 index ed35427e67..0000000000 --- a/integrations/astra/pydoc/config.yml +++ /dev/null @@ -1,31 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.retrievers.astra.retriever", - "haystack_integrations.document_stores.astra.document_store", - "haystack_integrations.document_stores.astra.errors", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Astra integration for Haystack - category_slug: integrations-api - title: Astra - slug: integrations-astra - order: 30 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_astra.md \ No newline at end of file diff --git a/integrations/astra/pyproject.toml b/integrations/astra/pyproject.toml index 51570c6e79..1aa83161dc 100644 --- a/integrations/astra/pyproject.toml +++ b/integrations/astra/pyproject.toml @@ -45,7 +45,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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/azure_ai_search/pydoc/config.yml deleted file mode 100644 index ec411af600..0000000000 --- a/integrations/azure_ai_search/pydoc/config.yml +++ /dev/null @@ -1,31 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Azure AI Search integration for Haystack - category_slug: integrations-api - title: Azure AI Search - slug: integrations-azure_ai_search - order: 180 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_azure_ai_search.md diff --git a/integrations/azure_ai_search/pyproject.toml b/integrations/azure_ai_search/pyproject.toml index be7cd822ce..eb1484df7d 100644 --- a/integrations/azure_ai_search/pyproject.toml +++ b/integrations/azure_ai_search/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/chroma/pydoc/config.yml deleted file mode 100644 index 1e678b4cc7..0000000000 --- a/integrations/chroma/pydoc/config.yml +++ /dev/null @@ -1,32 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Chroma integration for Haystack - category_slug: integrations-api - title: Chroma - slug: integrations-chroma - order: 40 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_chroma.md diff --git a/integrations/chroma/pyproject.toml b/integrations/chroma/pyproject.toml index 2ef1e004b5..c0118a58a7 100644 --- a/integrations/chroma/pyproject.toml +++ b/integrations/chroma/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/cohere/pydoc/config.yml deleted file mode 100644 index 291f6cdcea..0000000000 --- a/integrations/cohere/pydoc/config.yml +++ /dev/null @@ -1,35 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Cohere integration for Haystack - category_slug: integrations-api - title: Cohere - slug: integrations-cohere - order: 50 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_cohere.md diff --git a/integrations/cohere/pyproject.toml b/integrations/cohere/pyproject.toml index 558c43e1bc..a2b50fc8f0 100644 --- a/integrations/cohere/pyproject.toml +++ b/integrations/cohere/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/cometapi/pydoc/config.yml deleted file mode 100644 index 4dbb825bd1..0000000000 --- a/integrations/cometapi/pydoc/config.yml +++ /dev/null @@ -1,29 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.cometapi.chat.chat_generator", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Comet API integration for Haystack - category_slug: integrations-api - title: Comet API - slug: integrations-cometapi - order: 91 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_cometapi.md \ No newline at end of file diff --git a/integrations/cometapi/pyproject.toml b/integrations/cometapi/pyproject.toml index 03289b72da..cf1090aafc 100644 --- a/integrations/cometapi/pyproject.toml +++ b/integrations/cometapi/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/deepeval/pydoc/config.yml deleted file mode 100644 index b3372f42cf..0000000000 --- a/integrations/deepeval/pydoc/config.yml +++ /dev/null @@ -1,33 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: - [ - "haystack_integrations.components.evaluators.deepeval.evaluator", - "haystack_integrations.components.evaluators.deepeval.metrics", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: filter - expression: "name not in ['MetricResult', 'MetricDescriptor', 'OutputConverters', 'InputConverters', 'METRIC_DESCRIPTORS']" - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: DeepEval integration for Haystack - category_slug: integrations-api - title: DeepEval - slug: integrations-deepeval - order: 60 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_deepeval.md diff --git a/integrations/deepeval/pyproject.toml b/integrations/deepeval/pyproject.toml index a551d34664..656cfdca91 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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/elasticsearch/pydoc/config.yml deleted file mode 100644 index 39ffb2e5f3..0000000000 --- a/integrations/elasticsearch/pydoc/config.yml +++ /dev/null @@ -1,32 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.retrievers.elasticsearch.bm25_retriever", - "haystack_integrations.components.retrievers.elasticsearch.embedding_retriever", - "haystack_integrations.document_stores.elasticsearch.document_store", - "haystack_integrations.document_stores.elasticsearch.filters", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Elasticsearch integration for Haystack - category_slug: integrations-api - title: Elasticsearch - slug: integrations-elasticsearch - order: 70 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_elasticsearch.md \ No newline at end of file diff --git a/integrations/elasticsearch/pyproject.toml b/integrations/elasticsearch/pyproject.toml index 7716242fa1..bbf6bff5b6 100644 --- a/integrations/elasticsearch/pyproject.toml +++ b/integrations/elasticsearch/pyproject.toml @@ -50,7 +50,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/fastembed/pydoc/config.yml deleted file mode 100644 index 8ab538cf83..0000000000 --- a/integrations/fastembed/pydoc/config.yml +++ /dev/null @@ -1,34 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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" - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: FastEmbed integration for Haystack - category_slug: integrations-api - title: FastEmbed - slug: fastembed-embedders - order: 80 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_fastembed.md diff --git a/integrations/fastembed/pyproject.toml b/integrations/fastembed/pyproject.toml index af322fa8b3..6a9653a1ca 100644 --- a/integrations/fastembed/pyproject.toml +++ b/integrations/fastembed/pyproject.toml @@ -45,7 +45,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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/github/pydoc/config.yml deleted file mode 100644 index 040be3b93f..0000000000 --- a/integrations/github/pydoc/config.yml +++ /dev/null @@ -1,34 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: GitHub integration for Haystack - category_slug: integrations-api - title: GitHub - slug: integrations-github - order: 100 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_github.md \ No newline at end of file diff --git a/integrations/github/pyproject.toml b/integrations/github/pyproject.toml index fd7d9eb9aa..fc35e5025d 100644 --- a/integrations/github/pyproject.toml +++ b/integrations/github/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/google_ai/pydoc/config.yml deleted file mode 100644 index c2939a8129..0000000000 --- a/integrations/google_ai/pydoc/config.yml +++ /dev/null @@ -1,30 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.google_ai.gemini", - "haystack_integrations.components.generators.google_ai.chat.gemini", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Google AI integration for Haystack - category_slug: integrations-api - title: Google AI - slug: integrations-google-ai - order: 90 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_google_ai.md \ No newline at end of file diff --git a/integrations/google_ai/pyproject.toml b/integrations/google_ai/pyproject.toml index d282399e65..a09fa1aef9 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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/google_genai/pydoc/config.yml deleted file mode 100644 index 095a67c077..0000000000 --- a/integrations/google_genai/pydoc/config.yml +++ /dev/null @@ -1,31 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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" - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Google GenAI integration for Haystack - category_slug: integrations-api - title: Google GenAI - slug: integrations-google-genai - order: 91 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_google_genai.md \ No newline at end of file diff --git a/integrations/google_genai/pyproject.toml b/integrations/google_genai/pyproject.toml index 7b632efb28..5fa8c240ba 100644 --- a/integrations/google_genai/pyproject.toml +++ b/integrations/google_genai/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/google_vertex/pydoc/config.yml deleted file mode 100644 index 1dd94bbcb5..0000000000 --- a/integrations/google_vertex/pydoc/config.yml +++ /dev/null @@ -1,37 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Google Vertex integration for Haystack - category_slug: integrations-api - title: Google Vertex - slug: integrations-google-vertex - order: 100 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_google_vertex.md \ No newline at end of file diff --git a/integrations/google_vertex/pyproject.toml b/integrations/google_vertex/pyproject.toml index 5461b62186..8c650e4758 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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/hanlp/pydoc/config.yml deleted file mode 100644 index cd022ab654..0000000000 --- a/integrations/hanlp/pydoc/config.yml +++ /dev/null @@ -1,29 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.preprocessors.hanlp.chinese_document_splitter", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: HanLP integration for Haystack - category_slug: integrations-api - title: HanLP - slug: integrations-hanlp - order: 100 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_hanlp.md \ No newline at end of file diff --git a/integrations/hanlp/pyproject.toml b/integrations/hanlp/pyproject.toml index a3674d278e..9f18b20f46 100644 --- a/integrations/hanlp/pyproject.toml +++ b/integrations/hanlp/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/jina/pydoc/config.yml deleted file mode 100644 index 50a248de35..0000000000 --- a/integrations/jina/pydoc/config.yml +++ /dev/null @@ -1,34 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Jina integration for Haystack - category_slug: integrations-api - title: Jina - slug: integrations-jina - order: 130 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_jina.md diff --git a/integrations/jina/pyproject.toml b/integrations/jina/pyproject.toml index 82cc7557b2..2e59d29b30 100644 --- a/integrations/jina/pyproject.toml +++ b/integrations/jina/pyproject.toml @@ -48,7 +48,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/langfuse/pydoc/config.yml deleted file mode 100644 index c08bb35c37..0000000000 --- a/integrations/langfuse/pydoc/config.yml +++ /dev/null @@ -1,30 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.connectors.langfuse.langfuse_connector", - "haystack_integrations.tracing.langfuse.tracer", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Langfuse integration for Haystack - category_slug: integrations-api - title: langfuse - slug: integrations-langfuse - order: 136 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_langfuse.md diff --git a/integrations/langfuse/pyproject.toml b/integrations/langfuse/pyproject.toml index 712f0aa361..6324144a6a 100644 --- a/integrations/langfuse/pyproject.toml +++ b/integrations/langfuse/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/llama_cpp/pydoc/config.yml deleted file mode 100644 index a2b46c0990..0000000000 --- a/integrations/llama_cpp/pydoc/config.yml +++ /dev/null @@ -1,29 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.llama_cpp.generator", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Llama.cpp integration for Haystack - category_slug: integrations-api - title: Llama.cpp - slug: integrations-llama-cpp - order: 140 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_llama_cpp.md \ No newline at end of file diff --git a/integrations/llama_cpp/pyproject.toml b/integrations/llama_cpp/pyproject.toml index 597a18f986..758f810c59 100644 --- a/integrations/llama_cpp/pyproject.toml +++ b/integrations/llama_cpp/pyproject.toml @@ -56,7 +56,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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/llama_stack/pydoc/config.yml deleted file mode 100644 index 74c5e2b34e..0000000000 --- a/integrations/llama_stack/pydoc/config.yml +++ /dev/null @@ -1,29 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.llama_stack.chat.chat_generator", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Llama Stack integration for Haystack - category_slug: integrations-api - title: Llama Stack - slug: integrations-llama-stack - order: 200 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_llama_stack.md \ No newline at end of file diff --git a/integrations/llama_stack/pyproject.toml b/integrations/llama_stack/pyproject.toml index 146a61f103..4e782a4c3c 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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/mcp/pydoc/config.yml deleted file mode 100644 index 240b6e8540..0000000000 --- a/integrations/mcp/pydoc/config.yml +++ /dev/null @@ -1,30 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.tools.mcp.mcp_tool", - "haystack_integrations.tools.mcp.mcp_toolset", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: MCP integration for Haystack - category_slug: integrations-api - title: MCP - slug: integrations-mcp - order: 145 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_mcp.md diff --git a/integrations/mcp/pyproject.toml b/integrations/mcp/pyproject.toml index 9e1b72e0a2..0fe2cc8775 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.yml"] +docs = ["pydoc-markdown 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/meta_llama/pydoc/config.yml b/integrations/meta_llama/pydoc/config.yml deleted file mode 100644 index 1ad7f1b326..0000000000 --- a/integrations/meta_llama/pydoc/config.yml +++ /dev/null @@ -1,29 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.meta_llama.chat.chat_generator", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Meta Llama API integration for Haystack - category_slug: integrations-api - title: Meta Llama API - slug: integrations-meta-llama - order: 150 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_meta_llama.md diff --git a/integrations/meta_llama/pyproject.toml b/integrations/meta_llama/pyproject.toml index c05ae2d685..78ec4b40a3 100644 --- a/integrations/meta_llama/pyproject.toml +++ b/integrations/meta_llama/pyproject.toml @@ -45,7 +45,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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/mistral/pydoc/config.yml deleted file mode 100644 index 7ac3b8b999..0000000000 --- a/integrations/mistral/pydoc/config.yml +++ /dev/null @@ -1,32 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Mistral integration for Haystack - category_slug: integrations-api - title: Mistral - slug: integrations-mistral - order: 150 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_mistral.md \ No newline at end of file diff --git a/integrations/mistral/pyproject.toml b/integrations/mistral/pyproject.toml index e573746430..fc74c3d5c3 100644 --- a/integrations/mistral/pyproject.toml +++ b/integrations/mistral/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/mongodb_atlas/pydoc/config.yml deleted file mode 100644 index f16f801822..0000000000 --- a/integrations/mongodb_atlas/pydoc/config.yml +++ /dev/null @@ -1,32 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: MongoDB Atlas integration for Haystack - category_slug: integrations-api - title: MongoDB Atlas - slug: integrations-mongodb-atlas - order: 160 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_mongodb_atlas.md diff --git a/integrations/mongodb_atlas/pyproject.toml b/integrations/mongodb_atlas/pyproject.toml index d2460df5f3..58a3150206 100644 --- a/integrations/mongodb_atlas/pyproject.toml +++ b/integrations/mongodb_atlas/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/nvidia/pydoc/config.yml deleted file mode 100644 index f8f16a0747..0000000000 --- a/integrations/nvidia/pydoc/config.yml +++ /dev/null @@ -1,36 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Nvidia integration for Haystack - category_slug: integrations-api - title: Nvidia - slug: integrations-nvidia - order: 165 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_nvidia.md diff --git a/integrations/nvidia/pyproject.toml b/integrations/nvidia/pyproject.toml index 05469f6103..4f518c4dbe 100644 --- a/integrations/nvidia/pyproject.toml +++ b/integrations/nvidia/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/ollama/pydoc/config.yml deleted file mode 100644 index e8f2ca6e5c..0000000000 --- a/integrations/ollama/pydoc/config.yml +++ /dev/null @@ -1,32 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Ollama integration for Haystack - category_slug: integrations-api - title: Ollama - slug: integrations-ollama - order: 170 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_ollama.md diff --git a/integrations/ollama/pyproject.toml b/integrations/ollama/pyproject.toml index 312954c76a..f8991e13ce 100644 --- a/integrations/ollama/pyproject.toml +++ b/integrations/ollama/pyproject.toml @@ -50,7 +50,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/openrouter/pydoc/config.yml deleted file mode 100644 index 684258a69e..0000000000 --- a/integrations/openrouter/pydoc/config.yml +++ /dev/null @@ -1,29 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.openrouter.chat.chat_generator", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: OpenRouter integration for Haystack - category_slug: integrations-api - title: OpenRouter - slug: integrations-openrouter - order: 200 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_openrouter.md \ No newline at end of file diff --git a/integrations/openrouter/pyproject.toml b/integrations/openrouter/pyproject.toml index 5b01daaad0..45257537b5 100644 --- a/integrations/openrouter/pyproject.toml +++ b/integrations/openrouter/pyproject.toml @@ -45,7 +45,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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/opensearch/pydoc/config.yml deleted file mode 100644 index 414c9a0469..0000000000 --- a/integrations/opensearch/pydoc/config.yml +++ /dev/null @@ -1,33 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.retrievers.opensearch.bm25_retriever", - "haystack_integrations.components.retrievers.opensearch.embedding_retriever", - "haystack_integrations.components.retrievers.opensearch.open_search_hybrid_retriever", - "haystack_integrations.document_stores.opensearch.document_store", - "haystack_integrations.document_stores.opensearch.filters", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: OpenSearch integration for Haystack - category_slug: integrations-api - title: OpenSearch - slug: integrations-opensearch - order: 180 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_opensearch.md diff --git a/integrations/opensearch/pyproject.toml b/integrations/opensearch/pyproject.toml index dc3a3d90db..466863c445 100644 --- a/integrations/opensearch/pyproject.toml +++ b/integrations/opensearch/pyproject.toml @@ -48,7 +48,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/optimum/pydoc/config.yml deleted file mode 100644 index 62edc9502c..0000000000 --- a/integrations/optimum/pydoc/config.yml +++ /dev/null @@ -1,34 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Optimum integration for Haystack - category_slug: integrations-api - title: Optimum - slug: integrations-optimum - order: 185 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_optimum.md diff --git a/integrations/optimum/pyproject.toml b/integrations/optimum/pyproject.toml index b5c27b72cc..0183ca0529 100644 --- a/integrations/optimum/pyproject.toml +++ b/integrations/optimum/pyproject.toml @@ -59,7 +59,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/pgvector/pydoc/config.yml deleted file mode 100644 index 11be3aa4ae..0000000000 --- a/integrations/pgvector/pydoc/config.yml +++ /dev/null @@ -1,31 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.retrievers.pgvector.embedding_retriever", - "haystack_integrations.components.retrievers.pgvector.keyword_retriever", - "haystack_integrations.document_stores.pgvector.document_store", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Pgvector integration for Haystack - category_slug: integrations-api - title: Pgvector - slug: integrations-pgvector - order: 190 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_pgvector.md diff --git a/integrations/pgvector/pyproject.toml b/integrations/pgvector/pyproject.toml index 27fc28256d..c6701606c4 100644 --- a/integrations/pgvector/pyproject.toml +++ b/integrations/pgvector/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/pinecone/pydoc/config.yml deleted file mode 100644 index f49ec4ab45..0000000000 --- a/integrations/pinecone/pydoc/config.yml +++ /dev/null @@ -1,31 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: - [ - "haystack_integrations.components.retrievers.pinecone.embedding_retriever", - "haystack_integrations.document_stores.pinecone.document_store" - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Pinecone integration for Haystack - category_slug: integrations-api - title: Pinecone - slug: integrations-pinecone - order: 200 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_pinecone.md diff --git a/integrations/pinecone/pyproject.toml b/integrations/pinecone/pyproject.toml index 64b56dfc7a..cd42350e8d 100644 --- a/integrations/pinecone/pyproject.toml +++ b/integrations/pinecone/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/qdrant/pydoc/config.yml deleted file mode 100644 index 58ededdb51..0000000000 --- a/integrations/qdrant/pydoc/config.yml +++ /dev/null @@ -1,32 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: - [ - "haystack_integrations.components.retrievers.qdrant.retriever", - "haystack_integrations.document_stores.qdrant.document_store", - "haystack_integrations.document_stores.qdrant.migrate_to_sparse", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Qdrant integration for Haystack - category_slug: integrations-api - title: Qdrant - slug: integrations-qdrant - order: 210 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_qdrant.md diff --git a/integrations/qdrant/pyproject.toml b/integrations/qdrant/pyproject.toml index db61161008..64b4f33bc4 100644 --- a/integrations/qdrant/pyproject.toml +++ b/integrations/qdrant/pyproject.toml @@ -49,7 +49,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/ragas/pydoc/config.yml deleted file mode 100644 index 033bc738c1..0000000000 --- a/integrations/ragas/pydoc/config.yml +++ /dev/null @@ -1,30 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: - [ - "haystack_integrations.components.evaluators.ragas.evaluator" - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Ragas integration for Haystack - category_slug: integrations-api - title: Ragas - slug: integrations-ragas - order: 220 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_ragas.md diff --git a/integrations/ragas/pyproject.toml b/integrations/ragas/pyproject.toml index e6a1a32742..8b986797a6 100644 --- a/integrations/ragas/pyproject.toml +++ b/integrations/ragas/pyproject.toml @@ -46,7 +46,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/snowflake/pydoc/config.yml deleted file mode 100644 index 9c03ff45aa..0000000000 --- a/integrations/snowflake/pydoc/config.yml +++ /dev/null @@ -1,30 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: - [ - "haystack_integrations.components.retrievers.snowflake.snowflake_table_retriever", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Snowflake integration for Haystack - category_slug: integrations-api - title: Snowflake - slug: integrations-snowflake - order: 225 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_snowflake.md diff --git a/integrations/snowflake/pyproject.toml b/integrations/snowflake/pyproject.toml index b883f269c4..557df8e86f 100644 --- a/integrations/snowflake/pyproject.toml +++ b/integrations/snowflake/pyproject.toml @@ -52,7 +52,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/stackit/pydoc/config.yml deleted file mode 100644 index da13d83f34..0000000000 --- a/integrations/stackit/pydoc/config.yml +++ /dev/null @@ -1,31 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.stackit.chat.chat_generator", - "haystack_integrations.components.embedders.stackit.document_embedder", - "haystack_integrations.components.embedders.stackit.text_embedder", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: STACKIT integration for Haystack - category_slug: integrations-api - title: STACKIT - slug: integrations-stackit - order: 150 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_stackit.md \ No newline at end of file diff --git a/integrations/stackit/pyproject.toml b/integrations/stackit/pyproject.toml index 470c2f4750..a7756e918e 100644 --- a/integrations/stackit/pyproject.toml +++ b/integrations/stackit/pyproject.toml @@ -45,7 +45,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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/togetherai/pydoc/config.yml deleted file mode 100644 index 4921291e55..0000000000 --- a/integrations/togetherai/pydoc/config.yml +++ /dev/null @@ -1,30 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.generators.togetherai.generator", - "haystack_integrations.components.generators.togetherai.chat.chat_generator", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Together AI integration for Haystack - category_slug: integrations-api - title: Together AI - slug: integrations-together-ai - order: 170 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_togetherai.md diff --git a/integrations/togetherai/pyproject.toml b/integrations/togetherai/pyproject.toml index 45dc2c26b5..11f576bb4c 100644 --- a/integrations/togetherai/pyproject.toml +++ b/integrations/togetherai/pyproject.toml @@ -47,7 +47,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/unstructured/pydoc/config.yml deleted file mode 100644 index f2b4061a4a..0000000000 --- a/integrations/unstructured/pydoc/config.yml +++ /dev/null @@ -1,29 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.converters.unstructured.converter", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Unstructured integration for Haystack - category_slug: integrations-api - title: Unstructured - slug: integrations-unstructured - order: 230 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_unstructured.md diff --git a/integrations/unstructured/pyproject.toml b/integrations/unstructured/pyproject.toml index 8ac34e0f2b..8cefc3177f 100644 --- a/integrations/unstructured/pyproject.toml +++ b/integrations/unstructured/pyproject.toml @@ -51,7 +51,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/watsonx/pydoc/config.yml deleted file mode 100644 index 2bffc59646..0000000000 --- a/integrations/watsonx/pydoc/config.yml +++ /dev/null @@ -1,32 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: IBM watsonx.ai integration for Haystack - category_slug: integrations-api - title: IBM watsonx.ai - slug: integrations-watsonx - order: 240 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_watsonx.md \ No newline at end of file diff --git a/integrations/watsonx/pyproject.toml b/integrations/watsonx/pyproject.toml index 230a3b64ce..7171d9f63c 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.yml"] +docs = ["pydoc-markdown 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.yml b/integrations/weaviate/pydoc/config.yml deleted file mode 100644 index 51a38399ac..0000000000 --- a/integrations/weaviate/pydoc/config.yml +++ /dev/null @@ -1,34 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - 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", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Weaviate integration for Haystack - category_slug: integrations-api - title: Weaviate - slug: integrations-weaviate - order: 250 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_weaviate.md diff --git a/integrations/weaviate/pyproject.toml b/integrations/weaviate/pyproject.toml index 324e5f92ca..d1de7e963a 100644 --- a/integrations/weaviate/pyproject.toml +++ b/integrations/weaviate/pyproject.toml @@ -50,7 +50,7 @@ installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown 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/weights_and_biases_weave/pydoc/config.yml b/integrations/weights_and_biases_weave/pydoc/config.yml deleted file mode 100644 index 58b450ef06..0000000000 --- a/integrations/weights_and_biases_weave/pydoc/config.yml +++ /dev/null @@ -1,30 +0,0 @@ -loaders: - - type: haystack_pydoc_tools.loaders.CustomPythonLoader - search_path: [../src] - modules: [ - "haystack_integrations.components.connectors.weave.weave_connector", - "haystack_integrations.tracing.weave.tracer", - ] - ignore_when_discovered: ["__init__"] -processors: - - type: filter - expression: - documented_only: true - do_not_filter_modules: false - skip_empty_modules: true - - type: smart - - type: crossref -renderer: - type: haystack_pydoc_tools.renderers.ReadmeIntegrationRenderer - excerpt: Weights & Bias integration for Haystack - category_slug: integrations-api - title: weights and bias - slug: integrations-weights-bias - order: 260 - markdown: - descriptive_class_title: false - classdef_code_block: false - descriptive_module_title: true - add_method_class_prefix: true - add_member_class_prefix: false - filename: _readme_weights_and_bias.md diff --git a/integrations/weights_and_biases_weave/pyproject.toml b/integrations/weights_and_biases_weave/pyproject.toml index 1b819414f8..b7e8437b08 100644 --- a/integrations/weights_and_biases_weave/pyproject.toml +++ b/integrations/weights_and_biases_weave/pyproject.toml @@ -45,7 +45,7 @@ git_describe_command = 'git describe --tags --match="integrations/weights_and_bi installer = "uv" dependencies = ["haystack-pydoc-tools", "ruff"] [tool.hatch.envs.default.scripts] -docs = ["pydoc-markdown pydoc/config.yml"] +docs = ["pydoc-markdown pydoc/config_docusaurus.yml"] fmt = "ruff check --fix {args} && ruff format {args}" fmt-check = "ruff check {args} && ruff format --check {args}"