mkdocs.yml

site_name: pytom-match-pick
site_url: https://SBC-Utrecht.github.io/pytom-match-pick
site_author: Marten Chaillet
repo_name: pytom-match-pick
repo_url: https://github.com/SBC-Utrecht/pytom-match-pick
copyright: Copyright © 2024 Marten L. Chaillet

nav:
  - Home:
    - Overview: index.md
    - Usage: Usage.md
    - Timings: Timings.md
    - FAQ: Frequently-asked-questions-(FAQ).md
    - For developers: Developers.md
  - Tutorials:
    - Ribosomes on ER microsomes: tutorials/Tutorial.md
  - Benchmarks:
    - Measuring defocus handedness in EMPIAR-10985: benchmarks/defocus_handedness.md
  - Discussions: https://github.com/SBC-Utrecht/pytom-match-pick/discussions
  - Report a bug: https://github.com/SBC-Utrecht/pytom-match-pick/issues

theme:
  logo: images/60S_masked.png
  name: material
  features:
    - navigation.instant
    # - navigation.instant.progress  # possible progress bar, but site is too small to justify
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - toc.follow
    - content.code.copy

markdown_extensions:
        # - include
  - pymdownx.snippets:
      base_path: ["README.md", "src/pytom_tm/entry_points.py"]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css

plugins:
  - search
  - markdown-exec
  - glightbox