mkdocs.yml

site_name: Fractal Tasks Core

repo_url: https://github.com/fractal-analytics-platform/fractal-tasks-core
repo_name: fractal-tasks-core

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
      base_path:
        - fractal_tasks_core/__FRACTAL_MANIFEST__.json
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - footnotes

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

theme:
  name: "material"
  logo: https://raw.githubusercontent.com/fractal-analytics-platform/fractal-logos/refs/heads/main/common/fractal_logo.png
  favicon: https://raw.githubusercontent.com/fractal-analytics-platform/fractal-logos/refs/heads/main/common/fractal_favicon.png
  custom_dir: "docs/overrides"
  features:
    - content.code.annotate
    - content.code.copy
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: deep purple
    accent: light blue
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: deep purple
    accent: light blue
    toggle:
      icon: material/weather-night
      name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  navigation:
    expand: true


nav:
  - Home page: index.md
  - Install: install.md
  - Run tasks: run_tasks/
  - Task list: all_tasks.md
  - Table specs: tables.md
  - Write custom tasks: custom_task.md
  - Development: development.md
  - Code reference: reference/fractal_tasks_core/
  - Changelog: changelog.md

watch:
  - fractal_tasks_core

plugins:
  - search
  - autorefs
  - gen-files:
      scripts:
        - docs/_tasks/generate_task_list.py
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          import:
            - url: https://docs.python.org/objects.inv
            - url: https://numpy.org/doc/stable/objects.inv
            - url: https://zarr.readthedocs.io/en/stable/objects.inv
            - url: https://anndata.readthedocs.io/en/latest/objects.inv
            - url: https://docs.dask.org/en/stable/objects.inv
            # - url: https://docs.pydantic.dev/latest/objects.inv # This points to V2
          options:
            show_signature_annotations: false
            docstring_section_style: "spacy"
            docstring_style: "google"
            show_source: true
            filters: []
            show_root_full_path: false
  - include-markdown

extra_css:
  - extra.css

copyright: |
  © Copyright 2024
  University of Zurich
  (see <u><a href="https://github.com/fractal-analytics-platform/fractal-tasks-core/blob/main/LICENSE">
  LICENSE
  </a></u>).