mkdocs.yml

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

site_name: SQLAlchemy bind manager
site_description: 'A manager to easily handle multiple SQLAlchemy configurations'
site_author: 'Federico Busetti'
docs_dir: docs/
repo_name: 'febus982/sqlalchemy-bind-manager'
repo_url: 'https://github.com/febus982/sqlalchemy-bind-manager'

plugins:
  - search
  - awesome-pages
  - mike
#  - gen-files:
#      scripts:
#        - scripts/gen_pages.py  # or any other name or path
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            # General options
            show_source: true
            show_bases: false
            # Headings options
            show_root_heading: true
            show_root_members_full_path: true
            # Members options
            inherited_members: true
            group_by_category: true
            members_order: source
            # Docstrings options
            docstring_style: sphinx
            merge_init_into_class: false
            show_if_no_docstring: false
            # Signature options
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
            unwrap_annotated: true

theme:
  name: material
  custom_dir: mkdocs-overrides
  features:
    - navigation.expand
    - navigation.top
    - content.code.copy

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      primary: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    # Palette toggle for light mode
    - scheme: default
      media: "(prefers-color-scheme: light)"
      primary: teal
      toggle:
        icon: material/brightness-7
        name: Switch to auto mode

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/febus982/sqlalchemy-bind-manager
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/federico-b-a0b78232
  version:
    provider: mike
    default: stable

markdown_extensions:
  - pymdownx.details
  - pymdownx.blocks.admonition
  - pymdownx.blocks.details
  - pymdownx.snippets
  - pymdownx.superfences