yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-07-19 06:52:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
haystack/docs/pydoc/config/retriever.yml

27 lines
821 B
YAML
Raw Normal View History

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
re-organize pydoc config files (#4042)
2023-02-03 12:51:10 +01:00
search_path: [../../../haystack/nodes/retriever]
docs: separate abstract classes into separate API references (#5501) * separate_abstractions * img-to-text parent slug upd * Apply suggestions from code review Co-authored-by: Massimiliano Pippi <mpippi@gmail.com> --------- Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>
2023-08-07 12:21:25 +02:00
modules: ["sparse", "dense", "multimodal/retriever", "web", "link_content"]
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
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
re-organize pydoc config files (#4042)
2023-02-03 12:51:10 +01: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: Sweeps through a document store and returns a set of candidate documents that are relevant to the query.
category_slug: haystack-classes
title: Retriever API
slug: retriever-api
order: 170
markdown:
descriptive_class_title: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: retriever_api.md
Reference in New Issue Copy Permalink