mkdocs.yml

# basic configuration:
site_name: "metador-core"
site_description: "Core of Metador, the metadata-first research data management framework."
site_url: "https://materials-data-science-and-informatics.github.io/metador-core"
repo_url: "https://github.com/Materials-Data-Science-and-Informatics/metador-core"
edit_uri: "blob/main/docs/"
repo_name: "Materials-Data-Science-and-Informatics/metador-core"

# navigation structure (TOC + respective markdown files):
nav:
  - Home:
    - Overview: index.md
    - Changelog: changelog.md
    - Credits: credits.md
    - License: license.md
  - Usage:
    - Quickstart: quickstart.md
    - Notebooks:
      - Overview: notebooks/about.md
      - Creating a MetadorContainer: notebooks/01_MetadorContainer.ipynb
      - Writing Metador Plugins: notebooks/02_YourFirstMetadorPlugin.ipynb
      - Designing Metadata Schemas: notebooks/03_Schemas.ipynb
      - Semantics and Interoperability: notebooks/03b_SemanticsInteroperability.ipynb
    - API: reference/              # auto-generated (from Python docstrings)
  - Development:
    - How To Contribute: contributing.md
    - Developer Guide: dev_guide.md
    - Code of Conduct: code_of_conduct.md
    - Coverage Report: coverage.md # cov report (pytest --cov --cov-report html)

extra:
  # social links in footer:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/Materials-Data-Science-and-Informatics'
    - icon: 'fontawesome/solid/globe'
      link: 'https://github.com/Materials-Data-Science-and-Informatics'

  # versioned docs: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
  version:
    provider: mike

  # optimization for offline usage:
  use_directory_urls: !ENV [OFFLINE, false]

theme:
  # See here for customization guide: https://squidfunk.github.io/mkdocs-material/setup/
  name: "material"
  custom_dir: "docs/overrides"

  features:
  - content.action.edit
  - content.action.view
  # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations
  - content.code.annotate
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/
  - header.autohide
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
  - navigation.footer
  - navigation.instant
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.tracking
  - navigation.top
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
  - search.highlight
  - search.suggest

  # light/dark mode toggle: https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  # list of extra CSS files to override and configure defaults:
  - css/style.css

markdown_extensions:
  # Enable permalink to sections:
  - toc:
      permalink: true
  # Setting HTML/CSS attributes: https://python-markdown.github.io/extensions/attr_list/
  - attr_list
  # Definitions: https://python-markdown.github.io/extensions/definition_lists/
  - def_list
  # Footnotes: https://squidfunk.github.io/mkdocs-material/reference/footnotes/
  - footnotes
  # Various boxes: https://squidfunk.github.io/mkdocs-material/reference/admonitions/
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  # smart links: https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/
  - pymdownx.magiclink:
      repo_url_shorthand: true
  # Superscript: https://facelessuser.github.io/pymdown-extensions/extensions/caret/
  - pymdownx.caret
  # Strikethrough markup: https://facelessuser.github.io/pymdown-extensions/extensions/tilde/
  - pymdownx.tilde
  # Auto-Unicode for common symbols: https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/
  - pymdownx.smartsymbols
  # Github-style task list: https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist
  - pymdownx.tasklist:
      custom_checkbox: true
  # Tabbed boxes: https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/
  - pymdownx.tabbed:
      alternate_style: true
  # Inlining markdown: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
  - pymdownx.snippets:
      check_paths: true
  # Icons and Emoji: https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

plugins:
  # default search box (must be listed if plugins are added)
  - search
  # embed coverage report: https://pawamoy.github.io/mkdocs-coverage/
  - coverage
  # execute code (e.g. generate diagrams): https://pawamoy.github.io/markdown-exec/
  - markdown-exec
  # automatic API docs: https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages
  - gen-files:
      scripts:
      - docs/scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            members_order: source
            separate_signature: true
            show_signature_annotations: true
  # https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#built-in-offline-plugin
  # To allow building for offline usage, e.g. with: OFFLINE=true mkdocs build
  - offline:
      enabled: !ENV [OFFLINE, false]
  # to make multi-version docs work right
  - mike
  # include notebooks
  - mkdocs-jupyter:
      ignore: ["scripts/*"]

hooks:
  - docs/scripts/coverage_status.py

strict: true