mkdocs.yml

site_name: Vizro-AI
site_url: https://vizro.readthedocs.io/projects/vizro-ai
nav:
  - Vizro-AI: index.md
  - Tutorials:
      - Chart generation: pages/tutorials/quickstart.md
      - Dashboard generation: pages/tutorials/quickstart-dashboard.md
  - How-to guides:
      - FUNDAMENTALS:
          - Install Vizro-AI: pages/user-guides/install.md
          - Model setup: pages/user-guides/customize-vizro-ai.md
          - Different languages: pages/user-guides/use-different-languages.md
      - CHARTS:
          - Run vizro_ai.plot: pages/user-guides/run-vizro-ai.md
          - Advanced options: pages/user-guides/advanced-options.md
          - Advanced charts: pages/user-guides/create-advanced-charts.md
          - Add Vizro-AI charts to a Vizro dashboard: pages/user-guides/add-generated-chart-usecase.md
      - DASHBOARDS:
          - Generate a complex dashboard: pages/user-guides/create-complex-dashboard.md
          - Retrieve code for a generated dashboard: pages/user-guides/retrieve-dashboard-code.md
  - API Reference:
      - VizroAI: pages/API-reference/vizro-ai.md
  - Explanation:
      - FAQs: pages/explanation/faq.md
      - Disclaimer: pages/explanation/disclaimer.md
      - Safeguard code execution: pages/explanation/safeguard.md
      - Safety in Vizro-AI: pages/explanation/safety-in-vizro-ai.md
  - Examples:
      - Chart examples: pages/user-guides/chart-examples.md
  #- Contribute:
  #      - Contributing: pages/contribute/contributing.md
  - Vizro:
      - Vizro: https://vizro.readthedocs.io

#  This infers the version number of the latest release of whole repo, so we're hiding it for sub-packed in extra.css
repo_url: https://github.com/mckinsey/vizro/tree/main/vizro-ai
repo_name: mckinsey/vizro-ai

theme:
  name: material
  language: en
  palette:
    - scheme: default
  font:
    text: Inter
    code: Inter Regular
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - content.code.annotate

watch:
  - src

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.mark
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false #currently doesn't show source at correct level, and not for pydantic models
            docstring_style: google
            merge_init_into_class: true
            docstring_section_style: list
            separate_signature: true
            #   filters: ["!^_"]
            show_root_heading: true
            docstring_options:
              ignore_init_summary: true
              warn_unknown_params: false
          paths: [src]
  - git-revision-date-localized:
      enable_creation_date: false

extra_css:
  - stylesheets/extra.css

# Strictest settings possible, and will be elevated to ERROR when run with --strict.
# See https://www.mkdocs.org/user-guide/configuration/#validation.
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn