mkdocs.yml

site_name: Paricia
repo_url: https://github.com/ImperialCollegeLondon/paricia

theme:
  name: "material"
  features:
    - navigation.tabs

markdown_extensions:
  - admonition
  - pymdownx.snippets:
      check_paths: true
  - toc:
      permalink: "¤"
  - markdown_include.include:
      base_path: .
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_ref_nav.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - glightbox
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_category_heading: true
            merge_init_into_class: true
            members: true
          paths: [measurement]
  - caption:
      figure:
        ignore_classes: ["no-caption"]

nav:
  - User Guide:
      - Introduction: introduction.md
      - Reports: reports.md
      - Permissions: permissions.md
      - Adding elements: adding_elements.md
      - Importing Data: importing_data.md
      - Validation: validation.md
  - Developer Guide:
      - Contributing: contributing.md
      - Installation: installation.md
      - Quality assurance: quality_assurance.md
      - Synthetic data: synthetic_data.md
      - Administrators: admin.md
      - Code structure:
          - Index: Applications/index.md
          - Formatting: Applications/formatting.md
          - Variables: Applications/variable.md
          - Sensors: Applications/sensor.md
          - Stations: Applications/station.md
          - Measurements: Applications/measurement.md
          - Importing: Applications/importing.md
      - API Reference: reference/