yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-07-15 13:00:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
haystack/docs/pydoc/config/answer-generator.yml

27 lines
763 B
YAML
Raw Normal View History

Update Documentation for Haystack 0.5.0 (#557) * Add languages and preprocessing pages * add content * address review comments * make link relative * update api ref with latest docstrings * move doc readme and update * add generator API docs * fix example code * design and link fix Co-authored-by: Malte Pietsch <malte.pietsch@deepset.ai> Co-authored-by: PiffPaffM <markuspaff.mp@gmail.com>
2020-11-06 10:53:22 +01: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/answer_generator]
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: ["openai"]
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:
Update Documentation for Haystack 0.5.0 (#557) * Add languages and preprocessing pages * add content * address review comments * make link relative * update api ref with latest docstrings * move doc readme and update * add generator API docs * fix example code * design and link fix Co-authored-by: Malte Pietsch <malte.pietsch@deepset.ai> Co-authored-by: PiffPaffM <markuspaff.mp@gmail.com>
2020-11-06 10:53:22 +01:00
- type: filter
chore: fix all EOF (#3852) * fix all eof * fix test * fix test * fix test * typo * fix sample * fix sample * add logs * fix page_dynamic_result.txt
2023-01-16 12:34:50 +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
Update Documentation for Haystack 0.5.0 (#557) * Add languages and preprocessing pages * add content * address review comments * make link relative * update api ref with latest docstrings * move doc readme and update * add generator API docs * fix example code * design and link fix Co-authored-by: Malte Pietsch <malte.pietsch@deepset.ai> Co-authored-by: PiffPaffM <markuspaff.mp@gmail.com>
2020-11-06 10:53:22 +01: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: Reads a set of documents and generates an answer to a question, word by word
category_slug: haystack-classes
title: Answer Generator API
slug: answer-generator-api
Docs: Hide private modules from API docs (#4555) * Hide private modules and fix order * Add underscore
2023-04-04 15:07:18 +03:00
order: 5
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
markdown:
descriptive_class_title: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: answer_generator_api.md
Reference in New Issue Copy Permalink