mkdocs.yml

site_name: "Matchbox"
site_description: "Documentation for Matchbox"
repo_url: "https://github.com/uktrade/matchbox"
repo_name: "uktrade/matchbox"

nav:
- Home:
  - Welcome: index.md
  - Use cases: use-cases.md
- Client:
  - Installation: client/install.md
  - Retrieve: client/query-data.md
  - Link and deduplicate: client/link-data.md
  - API: 
    - Overview: api/client/index.md
- Server:
  - Install: server/install.md
  - Deploy: server/deploy.md
  - API: 
    - Overview: api/server/index.md
- API reference:
  - Client:
    - Overview: api/client/index.md
    - Clean: api/client/clean.md
    - Helpers: api/client/helpers.md
    - Models: api/client/models.md
    - Results: api/client/results.md
    - Visualisation: api/client/visualisation.md
  - Server: 
    - Overview: api/server/index.md
    - API: api/server/api.md
    - Backends:
      - PostgreSQL: api/server/backends/postgresql.md
  - Common: 
    - Overview: api/common/index.md
    - Database: api/common/db.md
    - Exceptions: api/common/exceptions.md
    - Factories: api/common/factories.md
    - Graph: api/common/graph.md
    - Hashing: api/common/hash.md
    - Logging: api/common/logging.md
    - Transform: api/common/transform.md
- Contributing:
  - Guidelines: contributing.md

theme:
  name: material
  logo: assets/matchbox-light.png
  favicon: assets/matchbox-dark.png
  features:
    - content.code.copy
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - 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: black
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to system preference

markdown_extensions:
  - attr_list
  - admonition
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - autorefs
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          import:
          - https://docs.python.org/3/objects.inv
          - https://typing-extensions.readthedocs.io/en/latest/objects.inv
          paths: [src]
          options:
            docstring_options:
              ignore_init_summary: true
            preload_modules: [matchbox]
            docstring_style: google
            docstring_section_style: list
            heading_level: 2
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: true
            separate_signature: true
            show_bases: false
            show_inheritance_diagram: true
            show_root_heading: true
            show_root_full_path: false
            show_source: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true

copyright: >
  <a href="https://www.flaticon.com/free-icons/ignite" title="ignite icons">Ignite icons created by edt.im - Flaticon</a>

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/uktrade/matchbox
  generator: false