mkdocs.yml

site_name: EvoTorch
site_description: EvoTorch is an open source evolutionary computation library developed at NNAISENSE, built on top of PyTorch.
repo_url: https://github.com/nnaisense/evotorch
repo_name: evotorch
copyright: Copyright © 2022 NNAISENSE SA

theme:
  name: material
  favicon: assets/favicon.ico
  custom_dir: docs/overrides
  features:
    - content.code.annotate
    # - content.tabs.link
    # - 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.integrate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: orange
      accent: orange
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - index.md
  - Quickstart: quickstart.md
  - User Guide:
    - user_guide/general_usage.md
    - Algorithm Usage: user_guide/algorithm_usage.md
    - Algorithms Tour: user_guide/algorithms_tour.md
    - Defining Problems: user_guide/problems.md
    - Problem Parallelization: user_guide/problem_parallelization.md
    - Logging: user_guide/logging.md
    - Neuroevolution: user_guide/neuroevolution.md
    - Neuroevolution for Gym: user_guide/gym.md
    - Supervised Neuroevolution: user_guide/supervised_ne.md
  - Advanced Usage:
    - advanced_usage/solution_batch.md
    - Using Hooks: advanced_usage/hooks.md
    - Distributed Evolution Strategies: advanced_usage/dist_based.md
    - Custom Searchers: advanced_usage/custom_ea.md
    - Custom Loggers: advanced_usage/custom_logger.md
    - Using Ray Clusters: advanced_usage/ray_cluster.md
  - Examples:
    - examples/index.md
    - Notebooks: examples/notebooks/
  - API Reference: reference/

plugins:
  - search
  - mkdocstrings
  - gen-files:
      scripts:
        - docs/gen_doc_stubs.py
  - literate-nav:
      nav_file: SUMMARY.md

watch:
  - examples/notebooks
  - src/evotorch

extra:
  homepage: https://evotorch.ai
  version:
    provider: mike

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js