sdk-bsp-rzn2l-etherkit/docs/source/config.yaml

# SDK 文档构建配置文件
project:
  name: "EtherKit SDK"
  title: "EtherKit"
  description: "EtherKit 开发板是 RT-Thread 推出基于瑞萨 Cortex-R52 架构 R9A07G084 芯片，为工程师们提供了一个灵活、全面的开发平台，助力开发者在EtherCAT工业以太网领域获得更深层次的体验。"
  description_en: "The EtherKit Development Board is RT-Thread's R9A07G084 chip based on Renesas Cortex-R52 architecture, providing engineers with a flexible and comprehensive development platform to help developers gain a deeper experience in EtherCAT industrial Ethernet."
  version: "1.0.0"
  author: "kurisaw"
  copyright: "Copyright (c) 2006-2025, RT-Thread Development Team"
  # language: "zh_CN"  # 注释掉固定语言配置，支持中英文双语
  website: "www.rt-thread.org"

# 仓库配置
repository:
  name: "sdk-bsp-rzn2l-etherkit"
  projects_dir: "../../projects"
  docs_dir: "."

# 文档分类配置
categories:
  start:
    name: "快速上手"
    name_en: "Getting Started"
    description: "快速上手"
    patterns:
      - "template_*"

  basic:
    name: "基础篇"
    name_en: "Basics"
    description: "基础功能示例"
    patterns:
      - "etherkit_basic_*"
      - "etherkit_blink_led"
  
  driver:
    name: "驱动篇"
    name_en: "Drivers"
    description: "外设驱动示例"
    patterns:
      - "etherkit_driver_*"
      - "etherkit_usb_*"
      - "etherkit_ethernet"
  
  component:
    name: "组件篇"
    description: "网络组件示例"
    name_en: "Components"
    patterns:
      - "etherkit_component_*"
  
  protocol:
    name: "工业协议篇"
    name_en: "Industrial Protocol"
    description: "工业协议示例"
    patterns:
      - "etherkit_ethercat_*"
      - "etherkit_modbus_*"
      - "etherkit_profinet_*"
      - "etherkit_ethernetip_*"

# 文档生成配置
generation:
  copy_files:
    - "README.md"
    - "README_zh.md"
  copy_dirs:
    - "figures"
  output_structure:
    - "start"
    - "basic"
    - "driver"
    - "component"
    - "protocol"

# Sphinx 配置
sphinx:
  theme: "sphinx_rtd_theme"
  extensions:
    - "myst_parser"
  source_suffix:
    ".rst": "restructuredtext"
    ".md": "markdown"
  myst_extensions:
    - "colon_fence"
    - "deflist"
    - "dollarmath"
    - "html_image"
    - "html_admonition"
    - "replacements"
    - "smartquotes"
    - "strikethrough"
    - "substitution"
    - "tasklist"