mkdocs.yml

site_name: taxidTools
site_url: https://cvua-rrw.github.io/taxidtools
site_description: Python library for taxonomy definitions
site_author: Gregoire Denay, Chemisches und Veterinaeruntersuchungsamt Rhein-Ruhr-Wupper - AoR
copyright: BSD 3-Clause license

repo_url: https://github.com/CVUA-RRW/taxidtools

nav:
  - Home: index.md
  - Usage:
      - Quickstart: usage/quickstart.md
      - Avanced usage: usage/advanced.md
  - Recipes:
      - Predictions vs. expectations: recipes/verify_blast.md
  - API reference: 
      - Taxonomy: api_doc/taxonomy.md
      - Constructors: api_doc/factories.md
      - Nodes: api_doc/nodes.md
      - Lineage: api_doc/lineage.md
  - About:
      - Contributing: about/contributing.md
      - License: about/license.md
      - History: about/history.md

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light blue
      accent: deep orange
      toggle:
        icon: material/eye
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate 
      primary: light blue
      accent: deep orange
      toggle:
        icon: material/eye-outline
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
    favicon: material/dna
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.path
    - toc.follow
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: numpy
            show_source: False
            inherited_members: True
            docstring_section_style: list

extra:
  analytics:
    provider: google
    property: G-3KVE44Z79K
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by 
            <a href="https://github.com/CVUA-RRW/taxidtools/issues/new/?title=[Webdoc Feedback]+{title}+-+{url}" target="_blank" rel="noopener">telling us what you need</a>.
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
      You can change your cookie settings at any time.

markdown_extensions:
  - attr_list
  - md_in_html
  - tables
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

copyright: >
  Copyright &copy; 2024 Grégoire Denay -
  <a href="#__consent">Change cookie settings</a>