mkdocs.yml

site_name: neb-dynamics
site_url: https://mtzgroup.github.io/neb-dynamics/
theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: orange
  features:
    - search.suggest
    - search.highlight
    - navigation.instant
    - navigation.expand
  icon:
    repo: fontawesome/brands/github-alt

repo_url: https://github.com/mtzgroup/neb-dynamics
edit_uri: edit/master/docs/
site_author: Jan Estrada Pabón
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          rendering:
            show_root_heading: False
            show_root_full_path: True
            show_category_heading: True
            show_signature_annotations: True
            show_if_no_docstring: True
            group_by_category: True
            heading_level: 2
          selection:
            new_path_syntax: True
            inherited_members: True
            filters:
              - "!^_"
              - "^__init__$"
markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - admonition
  - toc:
      permalink: 🔗 
  - markdown_include.include:
      base_path: docs