mkdocs.yml

site_name: BAV API Python SDK
site_url: https://wppbav.github.io/bavapi-sdk-python

repo_name: wppbav/bavapi-sdk-python
repo_url: https://github.com/wppbav/bavapi-sdk-python

copyright: Copyright © 2024 WPPBAV

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/wpp-bav-logo.svg
  favicon: assets/favicon.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
  palette:

  # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to dark mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Use system setting

extra_css: [extra.css]

extra:
  version:
    provider: mike

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - tables
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

nav:
  - Home:
      - Introduction: index.md
      - Release Notes: release-notes.md
      - Roadmap: roadmap.md
  - Getting Started:
      - Authentication: getting-started/authentication.md
      - Installation: getting-started/installation.md
      - Reference classes: getting-started/reference-classes.md
  - Usage:
      - Basic Usage: usage/basic.md
      - Advanced Usage: usage/advanced.md
      - Tools/TurboPitch: usage/tools.md
      - Usage Tips for Projects: usage/project-tips.md
  - Endpoints: endpoints/
  - SDK API Reference: reference/
  - Contributing: contributing.md
  - ↗ Fount API Documentation: https://developer.wppbav.com/docs/2.x/intro

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
        - docs/fetch_contributing.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mike
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
          paths: [bavapi]
          options:
            docstring_style: numpy
            merge_init_into_class: true

watch:
  - bavapi