mkdocs.yml

site_name: PicoQuake

repo_url: https://github.com/PLab-SI/PicoQuake
repo_name: PLab-SI/PicoQuake

nav:
  - Home: index.md
  - Specs: specs.md
  - Use Cases:
    - examples/trackpad.md
    - examples/bldc.md
  - Getting Started: getting_started.md
  - Documentation:
    - usage.md
    - plotting.md
    - acquisition_data.md
    - fw_update.md
    - cli.md
    - Python API:
      - Examples: python_api/examples.md
      - Reference:
        - python_api/interface.md
        - python_api/data.md
        - python_api/exceptions.md

theme:
  name: material
  palette:
    primary: custom
    accent: custom
  logo: assets/axes_symbol_round.svg
  favicon: assets/axes_symbol_round.svg
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_root_heading: true
            show_root_full_path: false
            show_source: false
            show_symbol_type_toc: true
            show_symbol_type_heading: true
            docstring_section_style: list

markdown_extensions:
  - admonition
  - pymdownx.details
  - md_in_html
  - pymdownx.superfences
  - pymdownx.highlight
  - attr_list
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/regular/envelope
      link: mailto:info@plab.si
  analytics:
    provider: google
    property: G-FHTMPZ6GSS

extra_css:
  - stylesheets/extra.css

copyright: Copyright &copy; 2024 <a href="https://www.plab.si">PLab</a>