mkdocs.yml

site_name: "Polaris"
site_description: "Polaris establishes a novel, industry‑certified standard to foster the development of impactful methods in AI-based drug discovery."
site_url: "https://github.com/polaris-hub/polaris"
repo_url: "https://github.com/polaris-hub/polaris"
repo_name: "polaris-hub/polaris"
copyright: Copyright 2023 - 2024 Polaris

remote_branch: "gh-pages"
use_directory_urls: false
docs_dir: "docs"

# Fail on warnings to detect issues with types and docstring
strict: true

nav:
  - Getting started:
      - Polaris: index.md
      - Quickstart: quickstart.md
  - Tutorials:
      - Basics: tutorials/basics.ipynb
      - Data Models: tutorials/custom_dataset_benchmark.ipynb
      - Creating Datasets:
          - Zarr Datasets: tutorials/dataset_zarr.ipynb
          - PDB Datasets: tutorials/dataset_pdb.ipynb
          - SDF Datasets: tutorials/dataset_sdf.ipynb
          - Optimization: tutorials/optimization.ipynb
      - Competitions:
          - tutorials/competition.participate.ipynb
  - API Reference:
      - Load: api/load.md
      - Core:
          - Dataset: api/dataset.md
          - Benchmark: api/benchmark.md
          - Subset: api/subset.md
          - Evaluation: api/evaluation.md
      - Competitions:
          - Competition Dataset: api/competition.dataset.md
          - Competition: api/competition.md
          - Competiton Evaluation: api/competition.evaluation.md
      - Hub:
          - Client: api/hub.client.md
          - External Auth Client: api/hub.external_client.md
          - PolarisFileSystem: api/hub.polarisfs.md
      - Additional:
          - Dataset Factory: api/factory.md
          - Data Converters: api/converters.md
          - Data Adapters: api/adapters.md
          - Base classes: api/base.md
          - Types: api/utils.types.md
  - Community: https://discord.gg/vBFd8p6H7u
  - Polaris Hub: https://polarishub.io/

theme:
  name: material
  # NOTE(hadim): to customize the material primary and secondary color,
  # see check `docs/assets/css/custom-polaris.css`.
  palette:
    primary: deep purple
    accent: indigo

  features:
    - navigation.tabs
    - navigation.sections
    - navigation.path
    - navigation.top
    - navigation.footer
    - toc.follow
    - content.code.copy
    - content.code.annotate
  favicon: images/logo-black.svg
  logo: images/logo-white.svg

extra_css:
  - assets/css/custom-polaris.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true

watch:
  - polaris/

plugins:
  - search

  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import sys
            - sys.path.append("docs")
            - sys.path.append("polaris")
          options:
            show_root_heading: yes
            heading_level: 3
            show_source: false
            group_by_category: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            line_length: 80
  - mkdocs-jupyter:
      execute: False
      remove_tag_config:
        remove_cell_tags: [ remove_cell ]
        remove_all_outputs_tags: [ remove_output ]
        remove_input_tags: [ remove_input ]

  - mike:
      version_selector: true

extra:
  version:
    # Multi versioning provider for mkdocs-material (used for the JS selector)
    provider: mike
  analytics:
    provider: google
    property: G-V4RP8SG194
    # Widget at the bottom of every page to collect information about the user experience
    # The data is collected in Google Analytics
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          # NOTE (cwognum): It could be useful to have a link to a feedback form here
          note: >-
            Thanks for your feedback!
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.