mkdocs.yml

# Project information
site_name: EvO AutoML
site_description: An evolution based framework that adapts to to evolving datastreams based on river
site_author: Cedric Kulbach
site_url: https://github.com/kulbachcedric/EvOAutoML

# Repository
repo_name: EvO AutoML
repo_url: https://github.com/kulbachcedric/EvOAutoML
edit_uri: "https://github.com/kulbachcedric/EvOAutoML"

# Copyright
copyright: Copyright © 2019 - 2020

# Configuration
theme:
  name: material
  custom_dir: docs/overrides
  language: en
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  font:
    text: Rubik
    code: Roboto Mono
  logo: img/logo_square.png
  #favicon: material/cloud
  features:
    - navigation.tabs
    - navigation.instant
    - navigation.indexes
    - navigation.tracking

# Extras
extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/online-ml/river-torch
  version:
    - provider: mike

# Extensions
markdown_extensions:
  - admonition
  - footnotes
  - toc:
      permalink: true
      toc_depth: "1-3"
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
        use_pygments: true
        pygments_lang_class: true

plugins:
  - search
  - awesome-pages
  - autorefs
  - mkdocs-jupyter:
      execute: True
      include: ["*.ipynb"]
  - gen-files:
      scripts:
        - docs/scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            docstring_section_style: spacy
            show_source: False
            merge_init_into_class: True


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