mkdocs.yml

site_name: "tea-tasting: statistical analysis of A/B tests"
site_url: https://tea-tasting.e10v.me/
site_description: A Python package for the statistical analysis of A/B tests
site_author: Evgeny Ivanov
copyright: © Evgeny Ivanov <br> The logo is designed by <a href="http://www.freepik.com/">Freepik</a>
repo_name: e10v/tea-tasting
repo_url: https://github.com/e10v/tea-tasting

nav:
  - Overview: index.md
  - User guide: user-guide.md
  - Data backends: data-backends.md
  - Power analysis: power-analysis.md
  - Multiple testing: multiple-testing.md
  - Custom metrics: custom-metrics.md
  - API reference:
    - API reference: api/index.md
    - Metrics:
      - Metrics: api/metrics/index.md
      - Base: api/metrics/base.md
      - Mean: api/metrics/mean.md
      - Proportion: api/metrics/proportion.md
      - Resampling: api/metrics/resampling.md
    - Experiment: api/experiment.md
    - Multiplicity: api/multiplicity.md
    - Datasets: api/datasets.md
    - Global configuration: api/config.md
    - Aggregates: api/aggr.md
    - Utilities: api/utils.md

theme:
  name: material
  palette: 
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  logo: assets/tea-cup-white.svg
  favicon: assets/tea-cup-white-on-black.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow
  
plugins:
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            filters: ["!^_"]
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            show_root_heading: true
  - search

markdown_extensions:
  - _strip_doctest_artifacts
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      permalink: "#"

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/override-copy.js