pydoc-markdown.yml

loaders:
  - type: python
    search_path: [
      ../../src/database_management/,
      ../../src/face_recog/haar_and_lbph/,
      ../../src/face_recog/openface/,
      ../../src/face_recog/,
      ../../src/web_application/,
      ../../src/web_application/app/,
      ../../src/eduVid/question_answering,
      ../../src/eduVid/handle_presentation(unused)
    ]
    modules:
      - base_database
      - picture_database
      - video_database
      - qa_algo_core
processors:
  - type: filter
    exclude_private: true
    documented_only: false
  - type: smart
  - type: crossref
renderer:
  type: mkdocs
  output_directory: ..
  content_directory_name: 'API documentation'
  clean_render: true
  pages:
    - title: Home
      name: README
      source: README.md
    - title: 'Database management'
      contents:
        - 'base_database.BaseDatabase.*'
        - 'picture_database.PictureDatabase.*'
        - 'video_database.VideoDatabase.*'
    - title: 'eduVid'
      contents:
        - 'qa_algo_core.HelperFN.*'
        - 'qa_algo_core.SpeechRecog.*'
        - 'qa_algo_core.QAAlgo.*'
  mkdocs_config:
    site_name: big-brother
    theme: readthedocs
    repo_url: https://github.com/Programmierpraktikum-MVA/big-brother