mkdocs.yml

site_name: cucaracha
repo_url: https://github.com/acsenrafilho/cucaracha
repo_name: acsenrafilho/cucaracha
edit_uri: tree/main/docs

theme:
  name: material
  language: en
  logo: assets/cucaracha-favicon.png
  favicon: assets/cucaracha-favicon.png
  palette:
    scheme: default
    primary: custom
    accent: red
  font:
    text: Noto Serif
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - content.footnote.tooltips
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.expand

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - footnotes

extra_css:
  - stylesheets/extra.css

nav:
  - 'index.md'
  - 'installation_guide.md'
  - 'faq.md'
  - 'getting_started.md'
  - 'api/document.md'
  - 'api/tasks/identification.md'
  - 'api/tasks/threshold.md'
  - 'api/tasks/aligment.md'
  - 'api/tasks/noise_removal.md'
  - 'api/ml_models/image_classification/img_class.md'
  - 'api/ml_models/image_segmentation/img_sem_seg.md'
  - 'api/ml_trainers/img_trainers.md'
  - 'contribute.md'

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [cucaracha]