mkdocs.yml

site_name: EQUi(Ne)<sup>2</sup> Documentation
site_author: Allan Wollaber, Steven Jorgensen, John Holodnak, Jensen Dempsey, and Harry Li
copyright: "Copyright (c) 2024 Massachusetts Institute of Technology, MIT Licensed" 
watch: [docs, src]
repo_url: https://github.com/mit-ll-responsible-ai/equine

nav:
- Home:
   - Overview: index.md
   - License: LICENSE.md
- Examples: 
   - Toy Problem with GP: example_notebooks/toy_example_GP.ipynb
   - Toy Problem with Protonet: example_notebooks/toy_example_EquineProtonet.ipynb
   - Image Classification: example_notebooks/MNIST_OOD_detection.ipynb
   - Encrypted Network Traffic: example_notebooks/vnat_example.ipynb
- Code Reference: reference/
- Development:
   - Contributing: CONTRIBUTING.md

theme:
  name: material
  features:
    - navigation.tabs
  palette: 
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7 
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  favicon: assets/favicon.svg
  icon:
    repo: fontawesome/brands/github

extra_css:
- css/mkdocstrings.css
- css/code_select.css
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.css

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML

markdown_extensions:
- admonition
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.snippets:
    check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.tasklist
- pymdownx.highlight:
    use_pygments: true
    pygments_lang_class: true
- pymdownx.arithmatex
- toc:
    permalink: "¤"

plugins:
- search
- gen-files:
    scripts:
    - docs/gen_ref_nav.py
- literate-nav:
    nav_file: SUMMARY.md
- section-index
- mkdocstrings:
    handlers:
      python:
        paths: [src]
        options:
           docstring_style: "numpy"
- mkdocs-jupyter:
    ignore_h1_titles: true
    include_source: true
#