haystack/docs/_src/api/pydoc/reader.yml

loaders:
  - type: python
    search_path: [../../../../haystack/nodes/reader]
    modules: ['base', 'farm', 'transformers', 'table']
    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: markdown
  descriptive_class_title: false
  descriptive_module_title: true
  add_method_class_prefix: true
  add_member_class_prefix: false
  filename: reader.md
Moved files to api directory (#418) 2020-09-22 11:48:26 +02:00			`loaders:`
			`- type: python`
Refactoring of the `haystack` package (#1624) * Files moved, imports all broken * Fix most imports and docstrings into * Fix the paths to the modules in the API docs * Add latest docstring and tutorial changes * Add a few pipelines that were lost in the inports * Fix a bunch of mypy warnings * Add latest docstring and tutorial changes * Create a file_classifier module * Add docs for file_classifier * Fixed most circular imports, now the REST API can start * Add latest docstring and tutorial changes * Tackling more mypy issues * Reintroduce from FARM and fix last mypy issues hopefully * Re-enable old-style imports * Fix some more import from the top-level package in an attempt to sort out circular imports * Fix some imports in tests to new-style to prevent failed class equalities from breaking tests * Change document_store into document_stores * Update imports in tutorials * Add latest docstring and tutorial changes * Probably fixes summarizer tests * Improve the old-style import allowing module imports (should work) * Try to fix the docs * Remove dedicated KnowledgeGraph page from autodocs * Remove dedicated GraphRetriever page from autodocs * Fix generate_docstrings.sh with an updated list of yaml files to look for * Fix some more modules in the docs * Fix the document stores docs too * Fix a small issue on Tutorial14 * Add latest docstring and tutorial changes * Add deprecation warning to old-style imports * Remove stray folder and import Dict into dense.py * Change import path for MLFlowLogger * Add old loggers path to the import path aliases * Fix debug output of convert_ipynb.py * Fix circular import on BaseRetriever * Missed one merge block * re-run tutorial 5 * Fix imports in tutorial 5 * Re-enable squad_to_dpr CLI from the root package and move get_batches_from_generator into document_stores.base * Add latest docstring and tutorial changes * Fix typo in utils __init__ * Fix a few more imports * Fix benchmarks too * New-style imports in test_knowledge_graph * Rollback setup.py * Rollback squad_to_dpr too Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2021-10-25 15:50:23 +02:00			`search_path: [../../../../haystack/nodes/reader]`
			`modules: ['base', 'farm', 'transformers', 'table']`
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`
Bring back init defs to api in v1.2 and latest (#2296) * Bring back init defs to api in v1.2 * Update Documentation & Code Style Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2022-03-10 15:01:05 +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:`
			`type: markdown`
Update API Reference Pages for v1.0 (#1729) * Create new API pages and update existing ones * Create query classifier page * Remove Objects suffix 2021-11-11 12:44:29 +01:00			`descriptive_class_title: false`
cleaning the api docs (#616) 2020-11-24 18:49:14 +01:00			`descriptive_module_title: true`
Adjust pydoc markdown config so methods shown with classes (#2511) * add_member_class_prefix: true * Update Documentation & Code Style * Trigger redeploy * Trigger redeploy * Fix pydoc param * Update Documentation & Code Style Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2022-05-06 16:00:08 +02:00			`add_method_class_prefix: true`
cleaning the api docs (#616) 2020-11-24 18:49:14 +01:00			`add_member_class_prefix: false`
Moved files to api directory (#418) 2020-09-22 11:48:26 +02:00			`filename: reader.md`