mkdocs.yml

site_name: SpectralClustering
site_description: Spectral Clustering documentation.
site_author: ROMI Team
site_url: https://romi.github.io/spectral-clustering/
copyright: 'The ROMI project has received funding from the European Community’s H2020 Programme under Grant Agreement No. 773875.'
repo_url: https://github.com/romi/spectral-clustering

nav:
  - 'Home': index.md
  - dev.md
  - 'Reference API': reference/


theme:
  name: 'material'
  font:
    text: Nunito Sans
    code: Ubuntu Mono
  logo: 'assets/images/ROMI_logo_white.svg'
  favicon: 'assets/images/ROMI_ICON_green.png'
  icon:
    repo: fontawesome/brands/github-alt
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.copy


extra:
  homepage: https://romi.github.io/spectral-clustering/
  social:
    - icon: fontawesome/brands/x-twitter
      link: 'https://twitter.com/ROMI_EU_PROJECT'
    - icon: fontawesome/brands/facebook
      link: 'https://www.facebook.com/ROMIEUProject'
    - icon: fontawesome/brands/github
      link: 'https://github.com/romi/spectral-clustering'
    - icon: fontawesome/brands/docker
      link: 'https://hub.docker.com/repository/docker/roboticsmicrofarms/plantimager/general'
  repo_name: spectral-clustering
  repo_url: https://github.com/romi/spectral-clustering


markdown_extensions:
  - admonition
  - attr_list
  - codehilite
  - footnotes
  - toc:
      permalink: Link
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
      pygments_style: "default"
      noclasses: true
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: python
          class: python
          validator: !!python/name:markdown_exec.validator
          format: !!python/name:markdown_exec.formatter
  - pymdownx.tabbed:
      alternate_style: true


plugins:
  - search
  - markdown-exec
  - gen-files:
      scripts:
        - docs/assets/scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://pandas.pydata.org/pandas-docs/stable/objects.inv
            - https://docs.scipy.org/doc/scipy/reference/objects.inv
            - https://matplotlib.org/stable/objects.inv
            - https://scikit-learn.org/stable/objects.inv
            - https://click.palletsprojects.com/en/stable/objects.inv
            - https://networkx.org/documentation/stable/objects.inv
          options:
            docstring_style: numpy
            docstring_section_style: list
            ignore_init_summary: true
            merge_init_into_class: true
            show_docstring_examples: true
            show_docstring_raises: true
            signature_crossrefs: true
            separate_signature: true



extra_css:
  - assets/css/extra.css


extra_javascript:
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
  - 'https://buttons.github.io/buttons.js'