Merge branch 'feature/update_screen_docs_driver' into 'master'

Feature: update screen docs driver Closes AEG-309 See merge request ae_group/esp-iot-solution!814
espressif · Nov 2, 2023 · d875ea8 · d875ea8
2 parents 696b395 + db811b2
commit d875ea8
Show file tree

Hide file tree

Showing 62 changed files with 1,354 additions and 619 deletions.
diff --git a/docs/_static/display/digit_cube_driver_CH450.png b/docs/_static/display/digit_cube_driver_CH450.png
diff --git a/docs/_static/display/mirror_x.png b/docs/_static/display/mirror_x.png
diff --git a/docs/_static/display/mirror_xy.png b/docs/_static/display/mirror_xy.png
diff --git a/docs/_static/display/mirror_y.png b/docs/_static/display/mirror_y.png
diff --git a/docs/_static/display/original.png b/docs/_static/display/original.png
diff --git a/docs/_static/display/screen/lcd_cmd_colmod.png b/docs/_static/display/screen/lcd_cmd_colmod.png
diff --git a/docs/_static/display/screen/lcd_cmd_control.png b/docs/_static/display/screen/lcd_cmd_control.png
diff --git a/docs/_static/display/screen/lcd_connection_i80.png b/docs/_static/display/screen/lcd_connection_i80.png
diff --git a/docs/_static/display/screen/lcd_connection_qspi.png b/docs/_static/display/screen/lcd_connection_qspi.png
diff --git a/docs/_static/display/screen/lcd_connection_rgb.png b/docs/_static/display/screen/lcd_connection_rgb.png
diff --git a/docs/_static/display/screen/lcd_connection_spi.png b/docs/_static/display/screen/lcd_connection_spi.png
diff --git a/docs/_static/display/screen/lcd_driver_ic.png b/docs/_static/display/screen/lcd_driver_ic.png
diff --git a/docs/_static/display/screen/lcd_gc9a01_block.png b/docs/_static/display/screen/lcd_gc9a01_block.png
diff --git a/docs/_static/display/screen/lcd_hardware.png b/docs/_static/display/screen/lcd_hardware.png
diff --git a/docs/_static/display/screen/lcd_hw_framework_qspi_with_gram.png b/docs/_static/display/screen/lcd_hw_framework_qspi_with_gram.png
diff --git a/docs/_static/display/screen/lcd_hw_framework_qspi_without_gram.png b/docs/_static/display/screen/lcd_hw_framework_qspi_without_gram.png
diff --git a/docs/_static/display/screen/lcd_hw_framework_rgb.png b/docs/_static/display/screen/lcd_hw_framework_rgb.png
diff --git a/docs/_static/display/screen/lcd_hw_framework_spi_i80.png b/docs/_static/display/screen/lcd_hw_framework_spi_i80.png
diff --git a/docs/_static/display/screen/lcd_resolution.png b/docs/_static/display/screen/lcd_resolution.png
diff --git a/docs/_static/display/screen/lcd_rgb_color_port.png b/docs/_static/display/screen/lcd_rgb_color_port.png
diff --git a/docs/_static/display/screen/lcd_shape_rect.png b/docs/_static/display/screen/lcd_shape_rect.png
diff --git a/docs/_static/display/screen/lcd_shape_round.png b/docs/_static/display/screen/lcd_shape_round.png
diff --git a/docs/_static/display/screen/lcd_size.png b/docs/_static/display/screen/lcd_size.png
diff --git a/docs/_static/display/screen/lcd_st7701_color_format.png b/docs/_static/display/screen/lcd_st7701_color_format.png
diff --git a/docs/_static/display/screen/lcd_st7701_interface_type.png b/docs/_static/display/screen/lcd_st7701_interface_type.png
diff --git a/docs/_static/display/screen/lcd_st7701_rgb_de.png b/docs/_static/display/screen/lcd_st7701_rgb_de.png
diff --git a/docs/_static/display/screen/lcd_st7701_rgb_pin.png b/docs/_static/display/screen/lcd_st7701_rgb_pin.png
diff --git a/docs/_static/display/screen/lcd_st7701_rgb_select.png b/docs/_static/display/screen/lcd_st7701_rgb_select.png
diff --git a/docs/_static/display/screen/lcd_st7701_rgb_sync.png b/docs/_static/display/screen/lcd_st7701_rgb_sync.png
diff --git a/docs/_static/display/screen/lcd_st7701_spi_pin.png b/docs/_static/display/screen/lcd_st7701_spi_pin.png
diff --git a/docs/_static/display/screen/lcd_st7789_interface.png b/docs/_static/display/screen/lcd_st7789_interface.png
diff --git a/docs/_static/display/screen/lcd_st7789_spi_3_4-line.png b/docs/_static/display/screen/lcd_st7789_spi_3_4-line.png
diff --git a/docs/_static/display/screen/lcd_st7789_spi_interface_I_II.png b/docs/_static/display/screen/lcd_st7789_spi_interface_I_II.png
diff --git a/docs/_static/display/screen/lcd_st7789_spi_pin.png b/docs/_static/display/screen/lcd_st7789_spi_pin.png
diff --git a/docs/_static/display/screen/lcd_st7789_spi_select.png b/docs/_static/display/screen/lcd_st7789_spi_select.png
diff --git a/docs/_static/display/screen/lcd_st77903_color_format.png b/docs/_static/display/screen/lcd_st77903_color_format.png
diff --git a/docs/_static/display/screen/lcd_st77903_interface_type.png b/docs/_static/display/screen/lcd_st77903_interface_type.png
diff --git a/docs/_static/display/screen/lcd_sw_framework.png b/docs/_static/display/screen/lcd_sw_framework.png
diff --git a/docs/_static/display/screen_driver_RGB565.png b/docs/_static/display/screen_driver_RGB565.png
diff --git a/docs/_static/display/screen_driver_gray.png b/docs/_static/display/screen_driver_gray.png
diff --git a/docs/_static/display/screen_driver_mono.png b/docs/_static/display/screen_driver_mono.png
diff --git a/docs/_static/display/screen_driver_structure.png b/docs/_static/display/screen_driver_structure.png
diff --git a/docs/_static/display/screen_offset.png b/docs/_static/display/screen_offset.png
diff --git a/docs/_static/display/screen_offset_rotate.png b/docs/_static/display/screen_offset_rotate.png
diff --git a/docs/_static/display/swap_xy.png b/docs/_static/display/swap_xy.png
diff --git a/docs/_static/display/swap_xy_mirror_x.png b/docs/_static/display/swap_xy_mirror_x.png
diff --git a/docs/_static/display/swap_xy_mirror_xy.png b/docs/_static/display/swap_xy_mirror_xy.png
diff --git a/docs/_static/display/swap_xy_mirror_y.png b/docs/_static/display/swap_xy_mirror_y.png
diff --git a/docs/en/display/index.rst b/docs/en/display/index.rst
@@ -7,7 +7,7 @@ Display
 .. toctree::
     :maxdepth: 1
 
-    Screen <screen>
+    LCD Screen <lcd/index>
     Digit Tube <digit_tube>
     LED lndicator <led_indicator>
 
diff --git a/docs/en/display/lcd/index.rst b/docs/en/display/lcd/index.rst
@@ -0,0 +1,12 @@
+LCD Screen
+**********
+
+:link_to_translation:`zh_CN:[中文]`
+
+.. toctree::
+    :maxdepth: 2
+
+    LCD Introduction <lcd_guide>
+    LCD Development Guide <lcd_development_guide>
+    SPI LCD Introduction <spi_lcd>
+    RGB LCD Introduction <rgb_lcd>
diff --git a/docs/en/display/lcd/lcd_development_guide.rst b/docs/en/display/lcd/lcd_development_guide.rst
@@ -0,0 +1,6 @@
+LCD Development Guide
+=====================
+
+:link_to_translation:`zh_CN:[中文]`
+
+Coming soon...
diff --git a/docs/en/display/lcd/lcd_guide.rst b/docs/en/display/lcd/lcd_guide.rst
@@ -0,0 +1,6 @@
+LCD Introduction
+================
+
+:link_to_translation:`zh_CN:[中文]`
+
+Coming soon...
diff --git a/docs/en/display/lcd/rgb_lcd.rst b/docs/en/display/lcd/rgb_lcd.rst
@@ -0,0 +1,6 @@
+RGB LCD Introduction
+====================
+
+:link_to_translation:`zh_CN:[中文]`
+
+Coming soon...
diff --git a/docs/en/display/lcd/spi_lcd.rst b/docs/en/display/lcd/spi_lcd.rst
@@ -0,0 +1,6 @@
+SPI LCD Introduction
+====================
+
+:link_to_translation:`zh_CN:[中文]`
+
+Coming soon...
diff --git a/docs/en/display/screen.rst b/docs/en/display/screen.rst
diff --git a/docs/zh_CN/display/index.rst b/docs/zh_CN/display/index.rst
@@ -1,12 +1,11 @@
-
 显示
 *************************
 
 :link_to_translation:`en:[English]`
 
 .. toctree::
-    :maxdepth: 1
+   :maxdepth: 1
 
-    显示屏 <screen>
+    LCD 显示屏 <lcd/index>
     数码管 <digit_tube>
     LED 指示灯<led_indicator>
diff --git a/docs/zh_CN/display/lcd/index.rst b/docs/zh_CN/display/lcd/index.rst
@@ -0,0 +1,12 @@
+LCD 显示屏
+***********************
+
+:link_to_translation:`en:[English]`
+
+.. toctree::
+    :maxdepth: 2
+
+    LCD 概述 <lcd_guide>
+    LCD 开发指南 <lcd_development_guide>
+    SPI LCD 详解 <spi_lcd>
+    RGB LCD 详解 <rgb_lcd>