mkdocs.yml

site_name: chitra
site_title: "A multi-functional full-stack Deep Learning Library"
site_description: "A multi-functional library for full-stack Deep Learning. Simplifies Model Building, API development, and Model Deployment."
banner_url: https://ik.imagekit.io/aniket/chitra/chitra_banner_0.1.0_tIzHC3b-y.png
repo_url: https://github.com/aniketmaurya/chitra/
repo_name: aniketmaurya/chitra

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/weather-night
        name: Switch to light mode

  logo: https://ik.imagekit.io/aniket/chitra/logo_0.1.0_qhktxqokb.png
  favicon: https://ik.imagekit.io/aniket/chitra/favicon/favicon_9A8ixLDnJ.ico
  features:
    - search.suggest
    - search.highlight

  # Necessary for search to work properly
  include_search_page: false
  search_index_only: true

markdown_extensions:
  - meta
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.superfences
  - admonition
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - toc:
      permalink: true

plugins:
  - git-revision-date-localized
  - search
  - autorefs
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import sys
            - sys.path.append('./')
          selection:
            new_path_syntax: true

extra:
  homepage: https://chitra.readthedocs.io/en/latest
  nbs_image:
    base_url: https://raw.githubusercontent.com/aniketmaurya/chitra/master/docs/assets/images

nav:
  - Introduction: 'index.md'
  - Image & Bounding Boxes: 'source/api/image/chitra-class.md'
  - Serve: 'source/api/serve/model_server.md'
  - Visualization: 'source/api/visualization/metrics.md'
  - Auto Docker Building: 'source/cli/builder/builder-create.md'
  - Examples:
      - Image Classification: 'examples/image-classification/image-classification.md'
      - Model Server: 'examples/model-server/model-server.md'

  - API References:
      - Image: 'chitra/image.md'
      - Coordinates: 'chitra/coordinates.md'
      - serve: 'chitra/serve.md'
      - CLI: 'chitra/cli.md'
      - visualization: 'chitra/visualization.md'
  - Release Notes: 'CHANGELOG.md'