mkdocs.yml

site_name: XRLint
repo_url: https://github.com/bcdev/xrlint
repo_name: bcdev/xrlint

copyright: Copyright © 2025 Brockmann Consult

nav:
  - Overview: index.md
  - Getting Started: start.md
  - Configuration: config.md
  - Rule Reference: rule-ref.md
  - CLI: cli.md
  - Python API: api.md
  - Examples: examples.md
  - About: about.md

theme:
  name: material
  # logo: assets/logo.png
  # favicon: assets/logo-small.png
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: blue grey
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bcdev/xrlint
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/xrlint/

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: list
            show_object_full_path: true
            show_root_toc_entry: true
            show_root_heading: true
            show_source: true
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            heading_level: 3
            annotations_path: brief
            members_order: source
            extra:
              show_overloads: true