mkdocs.yml

---
site_name: Pact Python
site_url: https://pact-foundation.github.io/pact-python/

repo_name: pact-foundation/pact-python
repo_url: https://github.com/pact-foundation/pact-python

edit_uri: edit/develop/docs

hooks:
  - docs/scripts/rewrite-docs-links.py

plugins:
  - search
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  # Library documentation
  - gen-files:
      scripts:
        - docs/scripts/markdown.py
        - docs/scripts/python.py
        # - docs/scripts/other.py
  - mkdocstrings:
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
          options:
            # General
            allow_inspection: true
            show_source: true
            show_bases: true
            # Headings
            heading_level: 2
            show_root_heading: false
            show_root_toc_entry: true
            show_root_full_path: true
            show_root_members_full_path: false
            show_object_full_path: false
            show_category_heading: true
            # Members
            filters:
              - '!^_'
              - '!^__'
            group_by_category: true
            show_submodules: false
            # Docstrings
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: spacy
            merge_init_into_class: true
            show_if_no_docstring: true
            # Signature
            annotations_path: brief
            show_signature: true
            show_signature_annotations: true
  - social
  - blog:
      blog_toc: true
      post_excerpt: required

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - tables
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.pathconverter:
      absolute: false
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

copyright: Copyright © 2023 Pact Foundation

theme:
  name: material

  icon:
    repo: fontawesome/brands/github

  features:
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.tracking
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest

  palette:
    - media: (prefers-color-scheme)
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: cyan
      accent: cyan
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: cyan
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to system preference

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pact-foundation/pact-python