mkdocs.yml

site_name: "super-image"
site_description: "State-of-the-art image super resolution models for PyTorch."
site_url: "https://eugenesiow.github.io/super-image"
repo_url: "https://github.com/eugenesiow/super-image"
repo_name: "eugenesiow/super-image"
site_dir: "site"

nav:
- Home:
  - Overview: index.md
  - Tutorials:
      - Prediction: prediction.md
      - Training: training.md
      - Evaluation: evaluation.md
  - Changelog: changelog.md
  - License: license.md
- Models:
  - EDSR: models/edsr.md
  - MSRN: models/msrn.md
  - A2N: models/a2n.md
  - PAN: models/pan.md
  - CARN: models/carn.md
- Reference:
  - CLI: reference/cli.md
  - Configuration: reference/configuration.md
  - Models: reference/models.md
  - Trainer: reference/trainer.md
- Development:
  - Contributing: contributing.md
  - Code of Conduct: code_of_conduct.md
  - Coverage report: coverage.md

theme:
  name: material
  features:
  - navigation.tabs
  palette:
    scheme: slate
    primary: teal
    accent: purple

extra_css:
- css/mkdocstrings.css

markdown_extensions:
- admonition
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.snippets:
    check_paths: true
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- toc:
    permalink: "#"

plugins:
- search
- coverage:
    html_report_dir: build/coverage
- mkdocstrings:
    watch:
    - src/super_image
    handlers:
      python:
        setup_commands:
          - import sys
          - sys.path.append("src")
- macros:
    module_name: docs/macros