haystack/docs/pydoc/config/document-store.yml
Silvano Cerza ee74421212
ci: Refactor docs config and generation (#4280)
* Change docs yml category config

* Update docs renderers to fetch categories from Readme.io

* Update readme_sync.yml to handle new docs rendering

* Remove unecessary script and related workflow step

* Fix sys.exits
2023-03-01 09:51:02 +01:00

42 lines
997 B
YAML

loaders:
- type: python
search_path: [../../../haystack/document_stores]
modules:
[
"base",
"elasticsearch",
"opensearch",
"memory",
"sql",
"faiss",
"milvus",
"weaviate",
"graphdb",
"deepsetcloud",
"pinecone",
"search_engine",
"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: renderers.ReadmeRenderer
excerpt: Stores your texts and meta data and provides them to the Retriever at query time.
category_slug: haystack-classes
title: Document Store API
slug: document-store-api
order: 30
markdown:
descriptive_class_title: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: document_store_api.md