mkdocs.yaml

site_name: Python API for Inscopix Data
site_author: Inscopix, Inc.
repo_url: https://github.com/inscopix/py_isx
repo_name: inscopix/py_isx
site_url: https://inscopix.github.io/py_isx/

docs_dir: 'docs'
theme:
  name: material
  logo: 'images/logo.png'
  palette:
    primary: '#87C440'
    accent: '#3D97CD'
  features:
    - navigation.indexes
    - navigation.tracking
    - toc.follow
    - content.code.copy
    - navigation.footer
    - content.tooltips
  favicon: favicon.png
 
nav:
  - Home: index.md
  - Install: installing.md
  - How To:
    - Determine version number: how-to/version-number.md
    - Read Cellsets:
      - Read the number of cells: how-to/read-cellsets-num-cells.md
      - Read a cell trace: how-to/read-cellsets-trace.md
      - Read the name of a cell: how-to/read-cellsets-name.md
      - Read the status of a cell: how-to/read-cellsets-status.md
      - Read the footprint of a cell: how-to/read-cellsets-footprint.md
      
      
    - Read Movies: 
      - Read movie timing information: how-to/read-movie-timing.md
      - Read movie spacing information: how-to/read-movie-spacing.md
      - Read movie data type: how-to/read-movie-data-type.md
      - Read a frame from a movie: how-to/read-movie-frame.md
  - API reference: 
    - Classes: reference/classes.md
    - Functions: reference/functions.md
  - Contributing: contributing.md
  - Support: support.md
  - FAQ: faq.md
  - License: LICENSE.md



use_directory_urls: false

markdown_extensions:
  - admonition
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji 
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - codehilite
  - footnotes
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - abbr
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true


plugins:
  - search
  - git-committers:
      repository: inscopix/py_isx
      branch: main
  - git-revision-date-localized:
      enable_creation_date: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            annotations_path: brief
            show_source: true
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: table
            filters: ["!^_"]
            heading_level: 3
            inherited_members: true
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            signature_crossrefs: true