haystack/docs/pydoc/config/document-store.yml

loaders:
  - type: loaders.CustomPythonLoader
    search_path: [../../../haystack/document_stores, ../../../haystack/document_stores/elasticsearch]
    modules:
      [
        "es7",
        "es8",
        "opensearch",
        "memory",
        "sql",
        "faiss",
        "weaviate",
        "deepsetcloud",
        "pinecone",
        "search_engine",
        "elasticsearch.base",
        "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
Moved files to api directory (#418) 2020-09-22 11:48:26 +02:00			`loaders:`
docs: Add inherited methods to API reference documentation (#5273) * Add inherited methods to API reference documentation * Fix typing 2023-08-02 18:54:15 +02:00			`- type: loaders.CustomPythonLoader`
docs: Add Elasticsearch to API config (#5422) 2023-07-24 16:23:13 +02:00			`search_path: [../../../haystack/document_stores, ../../../haystack/document_stores/elasticsearch]`
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			`modules:`
			`[`
docs: Add Elasticsearch to API config (#5422) 2023-07-24 16:23:13 +02:00			`"es7",`
			`"es8",`
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			`"opensearch",`
			`"memory",`
			`"sql",`
			`"faiss",`
			`"weaviate",`
			`"deepsetcloud",`
			`"pinecone",`
			`"search_engine",`
docs: Add Elasticsearch to API config (#5422) 2023-07-24 16:23:13 +02:00			`"elasticsearch.base",`
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			`"utils",`
			`]`
			`ignore_when_discovered: ["__init__"]`
Upgrade `pydoc-markdown` & refactor GitHub Actions (#2117) * Upgrade pydoc-markdown and fix the YAMLs to work with it * Pin pydoc-markdown to major version * Generalize pydoc-markdown workflow * Make a single Action to perform all tasks that require committing into the local branch * Merge the code updates and the docs in the Linux CI to prevent the bot from always show the pipeline as green * Installing Jupyter deps for Black * Build cache before running generation tasks * Add check not to run the code generation on master * Simplify push action * Add more test deps in setup.cfg and remove from GH Action workflow * Remove forced upgrades on pip install Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2022-02-04 15:45:09 +01:00			`processors:`
Moved files to api directory (#418) 2020-09-22 11:48:26 +02:00			`- type: filter`
Move Opensearch document store in its own module (#2603) * move OpenSearchDocumentStore into its own Python module * Update Documentation & Code Style * mark test with (sigh) elasticsearch * skip opensearch tests on windows Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2022-06-08 16:37:23 +02:00			`expression:`
Upgrade `pydoc-markdown` & refactor GitHub Actions (#2117) * Upgrade pydoc-markdown and fix the YAMLs to work with it * Pin pydoc-markdown to major version * Generalize pydoc-markdown workflow * Make a single Action to perform all tasks that require committing into the local branch * Merge the code updates and the docs in the Linux CI to prevent the bot from always show the pipeline as green * Installing Jupyter deps for Black * Build cache before running generation tasks * Add check not to run the code generation on master * Simplify push action * Add more test deps in setup.cfg and remove from GH Action workflow * Remove forced upgrades on pip install Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2022-02-04 15:45:09 +01:00			`documented_only: true`
			`do_not_filter_modules: false`
			`skip_empty_modules: true`
			`- type: smart`
			`- type: crossref`
Moved files to api directory (#418) 2020-09-22 11:48:26 +02:00			`renderer:`
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			`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`