Julian Risch db36d6277a
docs: Add readme sync for API docs 2.0 (#6173)
* add sync docs for preview

* add example config for audio docs

* hardcode version in renderer

* use custom renderer for preview docs

* update comment and excerpt
2023-10-27 14:53:03 +02:00

27 lines
828 B
YAML

loaders:
- type: loaders.CustomPythonLoader
search_path: [../../../haystack/preview/components/audio]
modules: ["whisper_local"]
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.ReadmePreviewRenderer
excerpt: LocalWhisperTranscriber transcribes audio files using OpenAI's Whisper models on your local machine
category_slug: haystack-classes
title: LocalWhisperTranscriber API
slug: local-whisper-transcriber-api
order: 10
markdown:
descriptive_class_title: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: local_whisper_transcriber_api.md