mkdocs.yml

site_name: CoSim - CETRAN open-source Simulation framework
repo_url: https://github.com/cetran-sg/CoSim
repo_name: cetran-sg/CoSim
theme:
  icon:
    repo: fontawesome/brands/github
  name: material
  highlightjs: true
  hljs_languages:
    - python
  features:
    - navigation.path
    - navigation.footer
    - navigation.instant
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
  custom_dir: docs/overrides
  icon:
    logo: fontawesome/solid/car-on
  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: grey
      toggle:
        icon: material/weather-night
        name: Switch to light mode

copyright: Copyright © 2024 Centre of Excellence for Testing & Research of Autonomous Vehicles - Nanyang Technological University

nav:
- 'index.md'
- 'Getting started':
  - 'Architecture': 'getting_started/architecture.md'
  - 'Map creation workflow' : 'getting_started/mapCreation.md'
- 'CoSim framework':
  - 'Prerequisites': 'cosim_framework/prerequisites.md'
  - 'CoSim Manager': 'cosim_framework/cosimManager.md'
  - 'Bridge client': 'cosim_framework/bridgeClient.md'
  - 'Bridge server': 'cosim_framework/bridgeServer.md'

plugins:
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            docstring_section_style: list
            ignore_init_summary: false
            merge_init_into_class: true
            show_root_toc_entry: true
            show_object_full_path: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            heading_level: 2
  - search
  - print-site: