mkdocs.yml

site_name: Labcore documentation page.

site_url: https://toolsforexperiments.github.io.

nav:
  - Home: index.md
  - Instruments:
    - Instrumentserver: instruments/instrumentserver.md
    - Our QCoDeS drivers: instruments/qcodes_instruments/instruments.md
  - Measurement:
    - Sweeping: measurement/sweep.md
  - Data:
    - Data Formats: data/data_formats.md
  - Examples:
      - Intro to our Holoviz apps: examples/Intro to our Holoviz apps.ipynb
      - Holoviz-based plotting in the lab: examples/Holoviz-based plotting in the lab - Primer.ipynb
  - About: about.md

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.instant
    - navigation.sections
    - navigation.tracking
    - navigation.top
    - search.suggest
    - search.highlight
    - permalink
  language: en
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

plugins:
  - search
  - autorefs
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        python:
          paths: [labcore]
          setup_commands:
            - import labcore
          docstring_style: sphinx
          selection:
            members: true
            inherited_members: true
          rendering:
            show_source: true
          parameter_headings: true
          options:
            extensions:
              - griffe_fieldz

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - admonition

copyright: |
  © 2024 Marcos Frenkel, Wolfgang Pfaff