config.yaml 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. # SDK 文档构建配置文件
  2. project:
  3. name: "EtherKit SDK"
  4. title: "EtherKit"
  5. description: "EtherKit 开发板是 RT-Thread 推出基于瑞萨 Cortex-R52 架构 R9A07G084 芯片,为工程师们提供了一个灵活、全面的开发平台,助力开发者在EtherCAT工业以太网领域获得更深层次的体验。"
  6. 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."
  7. version: "1.0.0"
  8. author: "kurisaw"
  9. copyright: "Copyright (c) 2006-2025, RT-Thread Development Team"
  10. # language: "zh_CN" # 注释掉固定语言配置,支持中英文双语
  11. website: "www.rt-thread.org"
  12. # 仓库配置
  13. repository:
  14. name: "sdk-bsp-rzn2l-etherkit"
  15. projects_dir: "../../projects"
  16. docs_dir: "."
  17. # 文档分类配置
  18. categories:
  19. start:
  20. name: "快速上手"
  21. name_en: "Getting Started"
  22. description: "快速上手"
  23. patterns:
  24. - "template_*"
  25. basic:
  26. name: "基础篇"
  27. name_en: "Basics"
  28. description: "基础功能示例"
  29. patterns:
  30. - "etherkit_basic_*"
  31. - "etherkit_blink_led"
  32. driver:
  33. name: "驱动篇"
  34. name_en: "Drivers"
  35. description: "外设驱动示例"
  36. patterns:
  37. - "etherkit_driver_*"
  38. - "etherkit_usb_*"
  39. - "etherkit_ethernet"
  40. component:
  41. name: "组件篇"
  42. description: "网络组件示例"
  43. name_en: "Components"
  44. patterns:
  45. - "etherkit_component_*"
  46. protocol:
  47. name: "工业协议篇"
  48. name_en: "Industrial Protocol"
  49. description: "工业协议示例"
  50. patterns:
  51. - "etherkit_ethercat_*"
  52. - "etherkit_modbus_*"
  53. - "etherkit_profinet_*"
  54. - "etherkit_ethernetip_*"
  55. # 文档生成配置
  56. generation:
  57. copy_files:
  58. - "README.md"
  59. - "README_zh.md"
  60. copy_dirs:
  61. - "figures"
  62. output_structure:
  63. - "start"
  64. - "basic"
  65. - "driver"
  66. - "component"
  67. - "protocol"
  68. # Sphinx 配置
  69. sphinx:
  70. theme: "sphinx_rtd_theme"
  71. extensions:
  72. - "myst_parser"
  73. source_suffix:
  74. ".rst": "restructuredtext"
  75. ".md": "markdown"
  76. myst_extensions:
  77. - "colon_fence"
  78. - "deflist"
  79. - "dollarmath"
  80. - "html_image"
  81. - "html_admonition"
  82. - "replacements"
  83. - "smartquotes"
  84. - "strikethrough"
  85. - "substitution"
  86. - "tasklist"