Merge branch 'feature/hide_eol_board' into 'master'

docs: relocate eol boards Closes DOC-8801 See merge request ae_group/esp-dev-kits!267
espressif · Jan 21, 2025 · c37abcf · c37abcf
2 parents 421a28a + c91ce83
commit c37abcf
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 34 deletions.
diff --git a/docs/conf_common.py b/docs/conf_common.py
@@ -27,6 +27,7 @@
 idf_targets = ['esp32', 'esp32s2', 'esp32s3', 'esp32c3', 'esp32c6', 'esp32h2', 'esp32c2', 'esp32p4', 'esp32c5', 'esp32c61', 'other']
 
 ESP32_DOCS = ['*.rst',
+              'eol/*.rst',
               'esp-wrover-kit/*.rst',
               'esp32-devkitc/*.rst',
               'esp32-devkitm-1/*.rst',
@@ -64,6 +65,7 @@
                 'esp32-c5-devkitc-1/*.rst'
                 ]
 ESP32S2_DOCS = ['*.rst',
+                'eol/*.rst',
                 'esp32-s2-devkitc-1/*.rst',
                 'esp32-s2-devkitm-1/*.rst',
                 'esp32-s2-hmi-devkit-1/*.rst',

diff --git a/docs/en/eol/eol-boards.rst b/docs/en/eol/eol-boards.rst
@@ -0,0 +1,29 @@
+:orphan:
+
+.. This page is only built for targets with EOL boards.
+
+EOL (End of Life) Boards
+------------------------
+
+:link_to_translation:`zh_CN:[中文]`
+
+This section contains user guides for the {IDF_TARGET_NAME} end-of-life development boards and is provided for reference only. While these boards may still be available on the market or used in legacy systems, they no longer receive updates, bug fixes, or official support. It is recommended to switch to newer development boards for better performance and more features.
+
+.. only:: esp32
+
+   .. toctree::
+      :maxdepth: 1
+
+      ESP32-Sense-Kit <../esp32-sense-kit/index>
+      ESP32-MeshKit-Sense <../esp32-meshkit-sensor/index>
+      ESP-WROVER-KIT <../esp-wrover-kit/index>
+
+.. only:: esp32s2
+
+   .. toctree::
+      :maxdepth: 1
+
+      ESP32-S2-HMI-DevKit-1 <../esp32-s2-hmi-devkit-1/index>
+      ESP32-S2-Touch-Devkit-1 <../esp32-s2-touch-devkit-1/index>
+      ESP32-S2-Kaluga-1 <../esp32-s2-kaluga-1/index>
+      ESP32-S2-Saola-1 <../esp32-s2-saola-1/index>
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -350,15 +350,7 @@ esp-dev-kits Documentation
 
       ESP32-S2-DevKitC-1 <esp32-s2-devkitc-1/index>
       ESP32-S2-DevKitM-1 <esp32-s2-devkitm-1/index>
-
-   .. toctree::
-      :hidden:
-      :caption: EOL (End of Life) Boards
-
-      ESP32-S2-HMI-DevKit-1 <esp32-s2-hmi-devkit-1/index>
-      ESP32-S2-Touch-Devkit-1 <esp32-s2-touch-devkit-1/index>
-      ESP32-S2-Kaluga-1 <esp32-s2-kaluga-1/index>
-      ESP32-S2-Saola-1 <esp32-s2-saola-1/index>
+      EOL (End of Life) Boards <eol/eol-boards>
 
 .. only:: esp32
 
@@ -373,14 +365,7 @@ esp-dev-kits Documentation
       ESP32-LCDKit <esp32-lcdkit/index>
       ESP32-Ethernet-Kit <esp32-ethernet-kit/index>
       ESP32-PICO-KIT <esp32-pico-kit/index>
-
-   .. toctree::
-      :hidden:
-      :caption: EOL (End of Life) Boards
-
-      ESP32-Sense-Kit <esp32-sense-kit/index>
-      ESP32-MeshKit-Sense <esp32-meshkit-sensor/index>
-      ESP-WROVER-KIT <esp-wrover-kit/index>
+      EOL (End of Life) Boards <eol/eol-boards>
 
 .. only:: other
 

diff --git a/docs/zh_CN/eol/eol-boards.rst b/docs/zh_CN/eol/eol-boards.rst
@@ -0,0 +1,29 @@
+:orphan:
+
+.. This page is only built for targets with EOL boards.
+
+寿命终止开发板
+--------------
+
+:link_to_translation:`en:[English]`
+
+本节包含 {IDF_TARGET_NAME} 寿命终止开发板的用户指南，内容仅供参考。这些开发板虽然可能仍在市场上销售或在遗留系统中使用，但已停止接收更新、错误修复及官方支持。建议切换至新款开发板，以享受更优性能和更丰富的功能。
+
+.. only:: esp32
+
+   .. toctree::
+      :maxdepth: 1
+
+      ESP32-Sense-Kit <../esp32-sense-kit/index>
+      ESP32-MeshKit-Sense <../esp32-meshkit-sensor/index>
+      ESP-WROVER-KIT <../esp-wrover-kit/index>
+
+.. only:: esp32s2
+
+   .. toctree::
+      :maxdepth: 1
+
+      ESP32-S2-HMI-DevKit-1 <../esp32-s2-hmi-devkit-1/index>
+      ESP32-S2-Touch-Devkit-1 <../esp32-s2-touch-devkit-1/index>
+      ESP32-S2-Kaluga-1 <../esp32-s2-kaluga-1/index>
+      ESP32-S2-Saola-1 <../esp32-s2-saola-1/index>
diff --git a/docs/zh_CN/index.rst b/docs/zh_CN/index.rst
@@ -350,15 +350,7 @@ esp-dev-kits 文档
 
       ESP32-S2-DevKitC-1 <esp32-s2-devkitc-1/index>
       ESP32-S2-DevKitM-1 <esp32-s2-devkitm-1/index>
-
-   .. toctree::
-      :hidden:
-      :caption: 寿命终止开发板
-
-      ESP32-S2-HMI-DevKit-1 <esp32-s2-hmi-devkit-1/index>
-      ESP32-S2-Touch-Devkit-1 <esp32-s2-touch-devkit-1/index>
-      ESP32-S2-Kaluga-1 <esp32-s2-kaluga-1/index>
-      ESP32-S2-Saola-1 <esp32-s2-saola-1/index>
+      寿命终止开发板 <eol/eol-boards>
 
 .. only:: esp32
 
@@ -373,14 +365,7 @@ esp-dev-kits 文档
       ESP32-LCDKit <esp32-lcdkit/index>
       ESP32-Ethernet-Kit <esp32-ethernet-kit/index>
       ESP32-PICO-KIT <esp32-pico-kit/index>
-
-   .. toctree::
-      :hidden:
-      :caption: 寿命终止开发板
-
-      ESP32-Sense-Kit <esp32-sense-kit/index>
-      ESP32-MeshKit-Sense <esp32-meshkit-sensor/index>
-      ESP-WROVER-KIT <esp-wrover-kit/index>
+      寿命终止开发板 <eol/eol-boards>
 
 .. only:: other