mkdocs.yml

site_name: Tianocore Edk2 Pytool Extensions (edk2toolext)
repo_url: https://github.com/tianocore/edk2-pytool-extensions
copyright: Copyright (c) Microsoft.  All rights reserved
site_description: edk2toolext package documentation

validation:
  links:
    absolute_links: relative_to_docs
    anchors: warn
    unrecognized_links: warn

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.indexes
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

docs_dir: docs/user

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
  - exclude:
      glob:
        - coverage.md
        - publishing.md
        - developing.md
  - gen-files:
      scripts:
        - docs/user/gen_api.py
  - awesome-pages

extra_javascript:
  - https://unpkg.com/mermaid@8.7.0/dist/mermaid.min.js

markdown_extensions:
  - markdown_include.include:
      base_path: .
  - admonition
  - codehilite
  - meta
  - fenced_code
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.tabbed
  - toc:
      permalink: true
watch:
  - 'docs/user'
  - 'mkdocs.yml'
  - 'edk2toolext/'

nav:
  - Our Philosophy: index.md
  - Using Stuart:
    - Installation Instructions: using/install.md
    - Build Instructions: using/build.md
    - Core CI Instructions: using/ci.md
    - Workspace Reporting: using/reporting.md
  - Integrating Stuart:
    - Build with Stuart: integrate/build.md
    - Core CI with Stuart: integrate/manage.md
    - Reports with Stuart: integrate/reporting.md
    - Porting Example: integrate/porting.md
  - ... | tools/**/*.md
  - ... | features/**/*.md
  - ... | api/**/*.md