mkdocs.yml

# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

site_name: ML Flashpoint Docs
site_url: https://google.github.io/ml-flashpoint

nav:
  - "Home": README.md
  - "Getting Started": user-guide.md
  - "Overview": overview.md
  # Keep Troubleshooting at the end.
  - "Troubleshooting": troubleshooting.md

theme:
  name: material
  palette:
  # Palette toggle for light mode
  - scheme: default
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  # Palette toggle for dark mode
  - scheme: slate
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  features:
    - navigation.indexes # Allow attaching content directly to sections.
    - navigation.expand # Expand all collapsible sections in left sidebar by default
    - navigation.path # To display breadcrumb navigation above the title on each page
    - navigation.top # Add a "back to top" button

plugins:
  # - nav-weight # To allow specifying nav_weight: <int> at the top of a doc for ordering
  # To enable generating documentation that can be served from a local filesystem.
  # - offline
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google # Matches project convention
            show_source: false
            show_root_heading: true
            show_root_full_path: false

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format