mkdocs.yml

site_name: Deep Search Toolkit
site_description: Documentation for Deep Search Toolkit
# site_url :
# Repository
repo_name: DS4SD/deepsearch-toolkit
repo_url: https://github.com/DS4SD/deepsearch-toolkit
edit_uri: edit/main/docs/

# Theme
theme:
  name: material
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  logo: favicon.svg
  favicon: favicon.svg
  features:
    - content.code.annotate
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    # - navigation.sections
    # - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  # - toc.integrate

  palette:
    - scheme: default
      primary: black
      accent: blue
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  language: en

nav:
  - Home: index.md
  - Examples [↗]: "https://github.com/DS4SD/deepsearch-examples"
  - User guide:
      - "guide/index.md"
      - Configuration: guide/configuration.md
      - Document conversion: guide/convert_doc.md
      - Projects: guide/projects.md
      - Data: guide/data_indices.md
      - Knowledge graphs: guide/kgs.md
      - APIs: guide/apis.md
      - Plugin system: guide/cli_plugins.md
  - API reference:
      - Toolkit reference: api-reference.md
      - OpenAPI:
          # - User API: apis/user/UserApi.md # TODO we should point to the main index of the generated docs, but this is currently missing
          - Public API: apis/public_v2/ # TODO we should point to the main index of the generated docs, but this is currently missing
      - CLI reference: cli-reference.md

# Copyright
copyright: Copyright &copy; 2024 <strong>IBM</strong> Research Europe – Deep Search team

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/DS4SD/deepsearch-toolkit
  generator: false
  analytics:
    provider: google
    property: G-KK2LZGCGFM

# Plugins
plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: false

markdown_extensions:
  - mkdocs-typer
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - md_in_html
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - 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

extra_css:
  - css/termynal.css
  - css/custom.css
extra_javascript:
  - js/termynal.js
  - js/custom.js