mkdocs.yml

site_name: yente-client
site_description: Python SDK, CLI, and MCP server for the yente / OpenSanctions matching API
site_url: https://yenteclient.followthemoney.tech/
repo_url: https://github.com/opensanctions/yente-client
repo_name: opensanctions/yente-client
edit_uri: edit/main/python/docs/

docs_dir: docs
site_dir: site  # gitignored; mkdocs build output

theme:
  name: material
  logo: https://assets.opensanctions.org/images/nura/logo-icon-white.svg
  favicon: https://assets.opensanctions.org/images/nura/favicon-32.png
  features:
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.suggest
  palette:
    primary: custom
    accent: custom
extra_css: [stylesheets/extra.css]

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true
            members_order: alphabetical
            filters:
              - "!^_"
          paths: [src]

nav:
  - Home: index.md
  - Tutorial: tutorial.md
  - Screening a file: screening.md
  - CLI overview: cli.md
  - MCP server: mcp.md
  - API reference:
      - api/index.md
      - Client: api/client.md
      - AsyncClient: api/async_client.md
      - Entities: api/entities.md
      - Filters: api/filters.md
      - Response models: api/models.md
      - Exceptions: api/exceptions.md
      - Schemas: api/schemas.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - toc:
      permalink: true