mkdocs.yml

site_name: "pytest-broadcaster"
site_description: "Pytest plugin to broadcast pytest output to various destinations."
site_url: "https://charbonnierg.github.io/pytest-broadcaster"
repo_url: "https://github.com/charbonnierg/pytest-broadcaster"
repo_name: "charbonnierg/pytest-broadcaster"
site_dir: "site"
copyright: Copyright © 2024 Guillaume Charbonnier
edit_uri: edit/main/docs/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

theme:
  name: material
  custom: .overrides
  logo: assets/pytest-discover-logo-darkmode-transparent.svg
  features:
  - announce.dismiss
  - content.action.edit
  - content.action.view
  - content.code.annotate
  - content.code.copy
  - content.tooltips
  - navigation.footer
  - navigation.indexes
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - search.highlight
  - search.suggest
  - toc.follow
  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
    
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: teal
    accent: purple
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode

  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    accent: lime
    toggle:
      icon: material/weather-night
      name: Switch to system preference

extra_css:
- css/style.css
- css/material.css
- css/mkdocstrings.css

markdown_extensions:
- attr_list
- admonition
- footnotes
- pymdownx.details
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
    pygments_lang_class: true
- pymdownx.inlinehilite:
    style_plain_text: python
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
    slugify: !!python/object/apply:pymdownx.slugs.slugify
      kwds:
        case: lower
- pymdownx.tasklist:
    custom_checkbox: true
- pymdownx.tilde
- toc:
    permalink: "¤"

plugins:
- search
- termynal
- mike
- gen-files:
    scripts:
    - scripts/generate-documentation.py
- literate-nav:
    nav_file: SUMMARY.md
- mkdocstrings:
    handlers:
      python:
        import:
        - https://docs.python.org/3/objects.inv
        - https://mkdocstrings.github.io/autorefs/objects.inv
        - https://docs.pytest.org/en/latest/objects.inv
        - https://docs.pydantic.dev/latest/objects.inv
        paths: [src]
        options:
          docstring_options:
            ignore_init_summary: true
          docstring_section_style: table
          filters: ["!^_"]
          heading_level: 3
          inherited_members: false
          merge_init_into_class: true
          separate_signature: true
          show_root_heading: true
          show_root_toc_entry: true
          show_root_full_path: false
          show_signature_annotations: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          signature_crossrefs: true
          summary: true
          preload_modules: [pytest, _pytest, _pytest.hookspec]
          allow_inspection: true
          find_stubs_package: true

extra:
  version:
    provider: mike
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/charbonnierg
  - icon: fontawesome/brands/python
    link: https://pypi.org/project/pytest-broadcaster/