site_name: Документация LWC
site_url: https://daniel-robotic.github.io/lightweight-cobot/
site_description: Документация по использованию коллаборативного робота KUKA LBR iiwa 7 и его программированию в среде ROS 2.
site_author: Даниил Грабарь

theme:
  name: material
  custom_dir: overrides
  language: ru
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.tabs.link      # синхронизирует все табы с одинаковым названием по всему сайту
    - content.code.copy      # кнопка "копировать" у код-блоков

plugins:
  - search
  - i18n:
      docs_structure: suffix
      reconfigure_material: true
      languages:
        - locale: ru
          name: Русский
          default: true
          build: true
        - locale: en
          name: English
          build: true
          site_name: LWC Documentation
          site_description: Documentation for using and programming the KUKA LBR iiwa 7 collaborative robot with ROS 2.
          site_author: Daniil Grabar
          nav_translations:
            Начало работы: Getting Started
            Обзор: Overview
            Настройка SunriseWorkbench: Sunrise Workbench setup
            Подключение к серверу: Connecting to the server
            Установка проекта: Project installation
            Конфигурация системы: System configuration
            Основные концепции: Core concepts
            Архитектура системы: System architecture
            CLI-инструмент cobot: cobot CLI
            FRI-протокол: FRI protocol
            Симуляция (Webots): Simulation (Webots)
            Планирование движений: Motion planning
            Использование LWC: Using LWC
            Управление через ROS2: Control via ROS 2
            Управление через Foxglove: Control via Foxglove
            Управление через REST API: Control via REST API
            Sunrise Workbench: Sunrise Workbench
            Установка: Installation
            Windows: Windows
            Linux: Linux
            Установка эмулятора Windows: Windows emulator installation
            Установка SunriseWorkbench: Sunrise Workbench installation
            Конфигурация проекта: Project configuration
            Создание нового проекта: Creating a new project
            Загрузка готового проекта: Loading an existing project
            Установка библиотек: Installing libraries
            KUKA LBR IIWA 7: KUKA LBR IIWA 7
            Описание программ: Program descriptions
            TeachKuka: TeachKuka
            ServerFriRos2: ServerFriRos2
            RobotPowerControl: RobotPowerControl
            Функциональные возможности: Features
            Станция: Station
            Дополнительное меню: Extra menu
            Приложения: Applications
            Меню робота: Robot menu
            Меню IO Group: IO Group menu
            Решение проблем: Troubleshooting
            Ошибка конфигурации: Configuration error
            Ошибка SSL (rosdep/setup): SSL error (rosdep/setup)
  - to-pdf:
      author: Даниил Грабарь
      cover_title: Документация LWC
      cover_subtitle: Lightweight Cobot
      output_path: pdf/documentation.pdf

extra_css:
  - assets/extra.css

extra_javascript:
  - assets/pdf_button.js

hooks:
  - hooks/pdf_default_language.py

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
nav:
  - Начало работы:
    - Обзор: getting-started/index.md
    - Настройка SunriseWorkbench: getting-started/sunrise-setup.md
    - Подключение к серверу:      getting-started/remote-access.md
    - Установка проекта:          getting-started/installation.md
    - Конфигурация системы:       getting-started/configuration.md

    - Основные концепции:
      - Архитектура системы:   getting-started/concepts/architecture.md
      - CLI-инструмент cobot:  getting-started/cli-reference.md
      - FRI-протокол:          getting-started/concepts/fri-protocol.md
      - Симуляция (Webots):    getting-started/concepts/simulation.md
      - Планирование движений: getting-started/concepts/motion-planning.md

    - Использование LWC:
      - Управление через ROS2:     getting-started/control/ros2-control.md
      - Управление через Foxglove: getting-started/control/foxglove.md
      - Управление через REST API: getting-started/control/rest-api.md

  - Sunrise Workbench:
    - Обзор: sunrise/overview.md
    - Установка:
      - Windows: sunrise/sun_install/windows.md
      - Linux:
        - Обзор: sunrise/sun_install/linux/linux.md
        - Установка эмулятора Windows: sunrise/sun_install/linux/emulator.md
        - Установка SunriseWorkbench:  sunrise/sun_install/linux/workbench.md
    - Конфигурация проекта:
      - Создание нового проекта:   sunrise/config/new-project.md
      - Загрузка готового проекта: sunrise/config/load-project.md
      - Установка библиотек:       sunrise/config/libraries.md
    - KUKA LBR IIWA 7:
      - Описание программ:
        - TeachKuka:         sunrise/kuka/programs/teach-kuka.md
        - ServerFriRos2:     sunrise/kuka/programs/server-fri-ros2.md
        - RobotPowerControl: sunrise/kuka/programs/robot-power-control.md
      - Функциональные возможности:
        - Станция:             sunrise/kuka/features/station.md
        - Дополнительное меню: sunrise/kuka/features/extra-menu.md
        - Приложения:          sunrise/kuka/features/applications.md
        - Меню робота:         sunrise/kuka/features/robot-menu.md
        - Меню IO Group:       sunrise/kuka/features/io-group.md

  - Решение проблем:
    - Ошибка конфигурации: troubleshooting/config-error.md
    - Ошибка SSL (rosdep/setup): troubleshooting/ssl-error.md