haystack/docs/pydoc-markdown.yml

loaders:
  - type: python
    search_path: [../haystack]
processor:
  - type: filter
    expression: not name.startswith('_') and default()
  - documented_only: true
  - do_not_filter_modules: false
  - skip_empty_modules: true
renderer:
  type: mkdocs
  pages:
    - title: DocumentStore
      contents:
        - document_store.base.*
        - document_store.elasticsearch.*
        - document_store.memory.*
        - document_store.sql.*
    - title: Retriever
      contents:
        - retriever.base.*
        - retriever.dense.*
        - retriever.sparse.*
    - title: Reader
      contents:
        - reader.base.*
        - reader.farm.*
        - reader.transformers.*
    - title: Preprocessing
      contents:
        - preprocessor.cleaning.*
        - preprocessor.utils.*
    - title: File Converters
      contents:
        - file_converter.base.*
        - file_converter.docx.*
        - file_converter.pdf.*
        - file_converter.txt.*
        - file_converter.tika.*
  mkdocs_config:
    mkdocs_config:
      site_name: Haystack
      theme: readthedocs