site_name: OpenAVMKit
site_description: Free and open source AVM (Automated Valuation Model) for real estate mass appraisal
repo_url: https://github.com/larsiusprime/openavmkit

theme:
  name: material
  logo: assets/images/logo.svg
  favicon: assets/images/favicon.ico
  features:
    - navigation.tabs
    - toc.integrate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          # where all of the toggles live now
          options:
            show_root_toc_entry: false
            # Signing & headings
            show_root_heading: false
            show_signature: true
            separate_signature: true
            docstring_style: numpy
            merge_init_into_class: true

            # Grouping into “Classes” / “Functions” sections
            group_by_category: true
            extra:
              show_subcategory_heading: false

          # where to find your code
          paths: [openavmkit]

  - gen-files:
      scripts:
        - docs/api/gen.py
  - literate-nav

nav:
  - Home: index.html
  - Docs: docs/
  - API: api/