mkdocs.yml

site_name: PyFLASH
site_description: Processing and analysis of immunofluorescence confocal microscopy data exported from FLASH/ImageJ workflows.
site_url: https://pyflash.readthedocs.io/
site_author: Brancaccio Lab

repo_url: https://github.com/Jay2owe/PyFLASH
repo_name: Jay2owe/PyFLASH
edit_uri: edit/master/docs/wiki/

docs_dir: docs/wiki
site_dir: site

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - awesome-pages

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

# Internal agent/maintainer context files and example scaffolding are not
# part of the public documentation.
exclude_docs: |
  **/CONTEXT.md
  examples/*.py
  examples/__pycache__/*

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Jay2owe/PyFLASH
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/PyFLASH-analysis/