mkdocs.yml

site_name: RedCoast
repo_url: https://github.com/tanyuqian/redco
site_url: https://tanyuqian.github.io/redco

nav:
  - RedCoast: index.md
  - Tutorial:
    - Data Parallel Only: tutorial/mnist_dp.md
    - Model Parallel: tutorial/mnist_mp.md
    - Differential-Private: tutorial/mnist_private.md
  - Documentation:
    - Trainer: docs/trainer.md
    - Predictor: docs/predictor.md
    - Deployer: docs/deployer.md

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: redco/
  - search


theme:
  name: material
  font:
    text: Ubuntu
    code: Ubuntu Mono
  favicon: images/redco_logo.png
  logo: images/redco_logo.png
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.instant
    - navigation.top
    - navigation.tracking
    - toc.follow
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      primary: brown
      scheme: black
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode

markdown_extensions:
  - admonition
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets
  - toc:
      permalink: true