mkdocs.yml

# Project information
site_name: Carotid Segmentation Documentation
# site_author: contributors
# site_url: https://XXX.readthedocs.io/
site_description: >-
  Open-source deep learning software for carotid segmentation
# Repository
repo_name:  MIAGroupUT/carotid-segmentation
repo_url: https://github.com/MIAGroupUT/carotid-segmentation

# Copyright
# copyright: XXX

# Configuration
theme:
  name: material
  icon:
    repo: material/github
  language: en
  # logo: images/logo.png
  # favicon: images/favicon.png
  features:
    - header.autohide
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

# Version panel
extra_javascript:
  - "https://code.jquery.com/jquery-3.3.1.min.js"

# Customization
extra:
  feature:
    tabs: true
  social:
    - icon: material/github
      link: https://github.com/MIAGroupUT
  version:
    default: latest

# Extensions
markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - md_in_html
  - toc:
      permalink: True

# Page tree
nav:
  - Home: index.md
  - Environment:
      - Data structure: Environment/Data.md
      - Deep learning models: Environment/Models.md
      - Config file: Environment/Configuration.md
  - Convert:
      - MICCAI2020: Convert/MICCAI2020.md
      - MICCAI2022: Convert/MICCAI2022.md
  - Transforms:
      - Heatmaps: Transforms/Heatmap.md
      - Centerlines: Transforms/Centerline.md
      - Polar images: Transforms/Polar.md
      - Contours: Transforms/Contour.md
      - Voxel-mask segmentation: Transforms/Segmentation.md
      - Full pipeline: Transforms/Pipeline.md
  - Compare:
      - Centerlines: Compare/Centerline.md
      - Contours: Compare/Contour.md
  - Train:
      - Contours: Train/Contour.md