haystack/docs/pydoc/config/other.yml

loaders:
  - type: python
    search_path: [../../../haystack/nodes/other]
    modules: ['docs2answers', 'join_docs', 'join_answers', 'route_documents', 'document_merger', 'shaper']
    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: The utility classes of Haystack.
   category: 6310ca73c622850ddd3875a2
   title: Other API
   slug: other-api
   order: 80
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
     filename: other_api.md
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:`
			`- type: python`
re-organize pydoc config files (#4042) 2023-02-03 12:51:10 +01:00			`search_path: [../../../haystack/nodes/other]`
Add shaper to api docs (#4083) 2023-02-08 12:15:08 +01:00			`modules: ['docs2answers', 'join_docs', 'join_answers', 'route_documents', 'document_merger', 'shaper']`
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			`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`
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`
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:`
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: The utility classes of Haystack.`
			`category: 6310ca73c622850ddd3875a2`
			`title: Other API`
			`slug: other-api`
			`order: 80`
			`markdown:`
			`descriptive_class_title: false`
			`descriptive_module_title: true`
			`add_method_class_prefix: true`
			`add_member_class_prefix: false`
			`filename: other_api.md`