mkdocs.yml

site_name: "DarkMAGIC"
site_url: "https://Griffin-Group.github.io/DarkMAGIC/"
repo_url: "https://github.com/Griffin-Group/DarkMAGIC/"
repo_name: "Griffin-Group/DarkMAGIC"
copyright: Copyright © 2024 Omar A. Ashour
edit_uri: blob/main/docs/

nav:
  - Home: index.md
  - Examples: examples.md
  - Formalism: formalism.md
  - Code Reference: reference/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

theme: 
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default 
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - search.highlight
    - search.share

extra:
  version:
    default: develop
    provider: mike

plugins:
  - search
  - mike
  - gen-files:
      scripts:
      - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            show_source: true
            members_order: source
            docstring_section_style: table
            merge_init_into_class: true
            docstring_options:
              ignore_init_summary: true
          import:
          - https://pymatgen.org/objects.inv
          - https://rad-tools.org/en/stable/objects.inv

extra_css:
- css/code_select.css
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

markdown_extensions:
- pymdownx.highlight:
    use_pygments: true
    pygments_lang_class: true
- pymdownx.arithmatex:
    generic: true

extra_javascript:
  - js/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js