haystack/docs/pydoc/config/ranker.yml

loaders:
  - type: python
    search_path: [../../../haystack/nodes/ranker]
    modules: ["base", "sentence_transformers"]
    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: Reorders a set of Documents based on their relevance to the Query.
  category_slug: haystack-classes
  title: Ranker API
  slug: ranker-api
  order: 150
  markdown:
    descriptive_class_title: false
    descriptive_module_title: true
    add_method_class_prefix: true
    add_member_class_prefix: false
    filename: ranker_api.md
update api markdown files and add markdown file for ranker (#1198) * update api markdown files and add markdown file for ranker * added docstrings for weaviate * new version of pydoc-markdown does not render arguments correctly. We used pydoc-markdown==3.11.0 2021-06-15 17:50:08 +02:00			`loaders:`
			`- type: python`
re-organize pydoc config files (#4042) 2023-02-03 12:51:10 +01:00			`search_path: [../../../haystack/nodes/ranker]`
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			`modules: ["base", "sentence_transformers"]`
			`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 api markdown files and add markdown file for ranker (#1198) * update api markdown files and add markdown file for ranker * added docstrings for weaviate * new version of pydoc-markdown does not render arguments correctly. We used pydoc-markdown==3.11.0 2021-06-15 17:50:08 +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`
update api markdown files and add markdown file for ranker (#1198) * update api markdown files and add markdown file for ranker * added docstrings for weaviate * new version of pydoc-markdown does not render arguments correctly. We used pydoc-markdown==3.11.0 2021-06-15 17:50:08 +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: Reorders a set of Documents based on their relevance to the Query.`
			`category_slug: haystack-classes`
			`title: Ranker API`
			`slug: ranker-api`
			`order: 150`
			`markdown:`
			`descriptive_class_title: false`
			`descriptive_module_title: true`
			`add_method_class_prefix: true`
			`add_member_class_prefix: false`
			`filename: ranker_api.md`
Docs: Add shaper API (#4288) * Add shaper and update category id * Fix the category id * Update category 2023-03-01 15:02:47 +02:00