mkdocs.yml

site_name: qim3d documentation
site_url: https://platform.qim.dk/qim3d/
site_author: qim3d contributors
site_description: Documentation for the qim3d python library
repo_url: https://lab.compute.dtu.dk/QIM/tools/qim3d
repo_name: Gitlab


nav:
  - Data handling:
    - Input and Output: doc/data_handling/io.md
    - Synthetic data: doc/data_handling/generate.md
  - Visualization: doc/visualization/viz.md
  - Image analysis:
    - Features: doc/image_analysis/features.md
    - Filters: doc/image_analysis/filters.md
    - Detection: doc/image_analysis/detection.md
    - Segmentation: doc/image_analysis/segmentation.md
    - Operations: doc/image_analysis/operations.md
    - Processing: doc/image_analysis/processing.md
    - Meshes: doc/image_analysis/mesh.md
  - Machine Learning: doc/ml/models.md
  - Graphical User Interfaces: doc/gui/gui.md
  - Command Line Interface: doc/cli/cli.md
  - Release history: doc/releases/releases.md

theme:
  language: en 
  name: material
  nav_position: top
  logo: assets/qim3d-icon.svg
  favicon: assets/qim3d-icon.svg
  features: 
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.instant
    # - navigation.tracking
    # - toc.integrate
    # - toc.follow
    - search.suggest
    # - content.tabs.link
    # - content.code.annotation
    - content.code.copy
    - content.code.annotate
    - header.autohide

  palette:
    primary: white
    accent: orange


extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/x-twitter 
      link: https://twitter.com/QIMCenter

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - admonition
  - attr_list
  - md_in_html
  - tables
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins: 
    - tags
    - search 
    - mkdocstrings:
        handlers:
          python:
            options:    
              show_root_heading: true
              show_source: true
              show_root_full_path: true
              show_object_full_path: true
              show_symbol_type_heading: false
              show_symbol_type_toc: false
              separate_signature: true