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

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: 6310ca73c622850ddd3875a2
   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:`
			`- type: python`
re-organize pydoc config files (#4042) 2023-02-03 12:51:10 +01:00			`search_path: [../../../haystack/document_stores]`
fix milvus imports (#3576) 2022-11-15 10:58:51 +01:00			`modules: ['base', 'elasticsearch', 'opensearch', 'memory', 'sql', 'faiss', 'milvus', 'weaviate', 'graphdb', 'deepsetcloud', 'pinecone', 'search_engine', 'utils']`
Moved files to api directory (#418) 2020-09-22 11:48:26 +02:00			`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:`
docs: sync Haystack API with Readme (#3223) * First pass at syncing Haystack API with Readme * Reapply changes * Regularize slugs * Regularize slugs * Regularize slugs * Set category id and regen * Trigger workflow * Delete old md files * Test sync * Undo test string * Incorporate reviewer feedback * Test on the fly API generation and sync * Test on the fly API generation and sync * Test on the fly API generation and sync * Test on the fly API generation and sync * Test on the fly API generation and sync * Change name of pydoc-markdown scripts * Test on the fly API generation and sync * Remove version tag * Test version tag * Test version tag * Test version tag * Revert test docstring * Revert md file changes * Revert md file changes * Revert script naming * Test on the fly generation and sync * Adjust for on the fly generation and sync * Revert test string * Remove old documentation workflow * Set workflow to work on main * Change readme version name 2022-09-21 17:18:34 +02:00			`type: renderers.ReadmeRenderer`
			`excerpt: Stores your texts and meta data and provides them to the Retriever at query time.`
			`category: 6310ca73c622850ddd3875a2`
			`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`