mkdocs.yml

site_name: pynapple
repo_url: https://github.com/pynapple-org/pynapple

theme:
  name: 'material'
  logo: images/Icon/Pynapple_final_icon_2.png
  favicon: images/Icon/Pynapple_final_icon.png
  palette:
    primary: 'green'
    features:
      - navigation.tabs
  markdown_extensions:
    - attr_list
    - admonition
    - tables
    - pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg

  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - announce.dismiss
    - navigation.tabs
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.path
    - navigation.sections
    - navigation.top
    - search.highlights
    - search.share
    - search.suggest      

plugins:
  - search
  - gallery:
        examples_dirs:
          - docs/api_guide
          - docs/examples
        gallery_dirs:          
          - docs/generated/api_guide
          - docs/generated/examples
        conf_script: docs/gallery_conf.py
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py            # Specify the script to generate the code reference pages
  - literate-nav:
        nav_file: docs/SUMMARY.md           # Specify the navigation file for literate-style navigation
  - section-index                           # Enable the section-index plugin for generating a section index
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: true
            members_order: source
            inherited_members: true
            show_root_heading: true
            separate_signature: true

nav:  
  - Overview: index.md
  - Install: installation.md
  - Quickstart: quickstart.md  
  - Application guide: generated/api_guide
  - Analysis examples: generated/examples
  - External projects: external.md
  - Pynajax - GPU acceleration: pynajax.md
  - Modules : reference/
  - Contributing: CONTRIBUTING.md
  - Authors: AUTHORS.md
  - History: HISTORY.md


extra_javascript:
  - 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

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

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - md_in_html
  - pymdownx.tabbed:
      alternate_style: true