mkdocs.yml

# Project information
site_name: ElementEmbeddings
site_url: https://wmd-group.github.io/ElementEmbeddings/
site_author: Anthony Onwuli

# Repository
repo_url: https://github.com/WMD-group/ElementEmbeddings
repo_name: "ElementEmbeddings"
edit_uri: ""

nav:
  - Home: index.md
  - About: about.md
  - Getting Started: installation.md
  - "Python package":
      - "Core module": "python_api/core.md"
      - "Composition module": "python_api/composition.md"
      - "Plotter module": "python_api/plotter.md"
      - "Utility module":
          - "io": python_api/utils/io.md
          - "Math": python_api/utils/math.md
          - "Species": python_api/utils/species.md
  - Tutorial:
      - "Simple usage": tutorials.md
      - "Core usage (notebook)": tutorial/usage.ipynb
      - "Composition usage (notebook)": tutorial/composition.ipynb
      - "Ionic Species (notebook)": tutorial/species.ipynb
  - Embedding Schemes:
      - "Element Embeddings": "embeddings/element.md"
      - Species Embeddings: "embeddings/species.md"
  - Contributing: contribution.md
  - Issue Tracker: https://github.com/WMD-group/ElementEmbeddings/issues

# Configuration
theme:
  name: material
  custom_dir: docs/.overrides
  features:
    - navigation.instant
    - navigation.tracking
    - content.code.copy

# Customisation
extra:
  version:
    provider: mike
    default: stable

plugins:
  - mkdocstrings
  - search
  - autorefs
  - mkdocs-jupyter:
      include_source: true
      execute: true
      allow_errors: false

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list
  - md_in_html
# Configuration