mkdocs.yml

site_name: Benchmarking Mutual Information
theme:
  icon:
    logo: material/alpha-i-box
  name: material
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline 
        name: Switch to dark mode
      primary: teal
      accent: purple 
    - scheme: slate 
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode    
      primary: teal
      accent: lime

repo_name: BMI
repo_url: https://github.com/cbg-ethz/bmi

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
  - bibtex:
      bib_file: 'references.bib'

nav:
  - Home: index.md
  - Estimators: estimators.md
  - Benchmark: benchmarking-new-estimator.md
  - Bend and Mix Models: bmm.md
  - Contributing: contributing.md
  - API: api/index.md


watch:
  - src/bmi

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/cbg-ethz/bmi

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg


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