mkdocs.yml

### Site metadata ###

site_name: Nebula
site_description: Nebula Multi-Sensor Driver Framework

repo_url: https://github.com/tier4/nebula
docs_dir: docs
copyright: Copyright © 2023 TIER IV, Inc.

### Theme settings ###
theme:
  name: material
  language: en
  # logo: docs/logo.png
  # favicon: docs/favicon.png
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
  palette:
    - scheme: default
      primary: white
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: grey
      toggle:
        icon: material/weather-night
        name: Switch to light mode
use_directory_urls: true

### Navigation ###
nav:
  - Home: index.md
  - About: about.md
  - Installation: installation.md
  - Launching: usage.md
  - Design: design.md
  - Parameters: parameters.md
  - Point cloud types: point_types.md
  - Supported sensors: supported_sensors.md
  - Tutorials: tutorials.md
  - Contributing: contribute.md
  - Nebula common: nebula_common/links.md
  - Nebula decoders: nebula_decoders/links.md
  - Nebula HW interfaces: nebula_hw_interfaces/links.md
  - Nebula ROS: nebula_ros/links.md

### Extra Settings ###
plugins:
  - mkdoxy:
      projects:
        nebula_common:
          src-dirs: nebula_common/include
          full-doc: true
          doxy-cfg:
            FILE_PATTERNS: "*.hpp *.h"
            RECURSIVE: true
            EXTRACT_ALL: true
            INLINE_SOURCES: true
            ENABLE_PREPROCESSING: true
            MACRO_EXPANSION: true
        nebula_decoders:
          src-dirs: nebula_decoders/include
          full-doc: true
          doxy-cfg:
            FILE_PATTERNS: "*.hpp *.h"
            RECURSIVE: true
            EXTRACT_ALL: true
            INLINE_SOURCES: true
            ENABLE_PREPROCESSING: true
            MACRO_EXPANSION: true
        nebula_hw_interfaces:
          src-dirs: nebula_hw_interfaces/include
          full-doc: true
          doxy-cfg:
            FILE_PATTERNS: "*.hpp *.h"
            RECURSIVE: true
            EXTRACT_ALL: true
            INLINE_SOURCES: true
            ENABLE_PREPROCESSING: true
            MACRO_EXPANSION: true
        nebula_ros:
          src-dirs: nebula_ros/include
          full-doc: true
          doxy-cfg:
            FILE_PATTERNS: "*.hpp *.h"
            RECURSIVE: true
            EXTRACT_ALL: true
            INLINE_SOURCES: true
            ENABLE_PREPROCESSING: true
            MACRO_EXPANSION: true

      save-api: .mkdoxy
      full-doc: true
      debug: false
      ignore-errors: false

  - search:
      lang: en

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences