Skip to content

Commit

Permalink
doc: Update doc configs
Browse files Browse the repository at this point in the history
  • Loading branch information
shadeMe committed Nov 20, 2024
1 parent 65dd328 commit 8b11072
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
32 changes: 32 additions & 0 deletions docs/pydoc/config/document_stores_api.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
loaders:
- type: haystack_pydoc_tools.loaders.CustomPythonLoader
search_path: [../../../]
modules:
[
"haystack_experimental.document_stores.in_memory.document_store",
"haystack_experimental.document_stores.opensearch.document_store",
"haystack_experimental.document_stores.types.protocol",
]
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.ReadmeCoreRenderer
excerpt: Stores your texts and meta data and provides them to the Retriever at query time.
category_slug: experiments-api
title: Document Stores
slug: experimental-document-stores-api
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: document_stores_api.md
6 changes: 4 additions & 2 deletions docs/pydoc/config/retrievers_api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ loaders:
modules:
[
"haystack_experimental.components.retrievers.auto_merging_retriever",
"haystack_experimental.components.retrievers.chat_message_retriever"
"haystack_experimental.components.retrievers.chat_message_retriever",
"haystack_experimental.components.retrievers.opensearch.bm25_retriever",
"haystack_experimental.components.retrievers.opensearch.embedding_retriever",
]
ignore_when_discovered: ["__init__"]
processors:
Expand All @@ -28,4 +30,4 @@ renderer:
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: experimental_retrievers_api.md
filename: experimental_retrievers_api.md

0 comments on commit 8b11072

Please sign in to comment.