docs(integration): reorganize the files (#8701)

2026-05-28 13:36:27 +08:00 · 2025-08-29 20:14:04 +02:00
parent 859559cfaf
commit 2e8f375791
112 changed files with 512 additions and 389 deletions
@@ -1,10 +1,15 @@
-======
+.. _boards:
-Boards
+
-======
+=============
 Board Support
 =============
 .. toctree::
-    :maxdepth: 2
+    :class:    toctree-1-deep
    :maxdepth: 1
-    toradex
+
-    riverdi
+    lvgl_supported
-    viewe
+    partner_supported
    manufacturers/index
@@ -0,0 +1,3 @@
 ==============
 LVGL Supported
 ==============
@@ -0,0 +1,6 @@
 ====
 ICOP
 ====
 TODO
@@ -0,0 +1,11 @@
 ======
 Boards
 ======
 .. toctree::
    :maxdepth: 2
    icop
    toradex
    riverdi
    viewe
@@ -0,0 +1,3 @@
 =================
 Partner Supported
 =================
@@ -1,6 +1,6 @@
-=============
+====================
-Build Systems
+Build System Support
-=============
+====================
 .. toctree::
@@ -1,13 +0,0 @@
 ============
 Chip vendors
 ============
 .. toctree::
    :maxdepth: 2
    alif
    arm
    espressif
    nxp
    renesas/index
    stm32
@@ -0,0 +1,3 @@
 ==========
 Dave2D GPU
 ==========
@@ -0,0 +1,12 @@
 .. _alif:
 ====
 Alif
 ====
 .. toctree::
    :maxdepth: 2
    overview
    dave2d_gpu
@@ -1,8 +1,8 @@
-.. _alif:
+.. _alif_overview:
-====
+========
-Alif
+Overview
-====
+========
 Alif Semiconductor is a next-generation chip vendor making chips that come in a
 variety of configurations. Their chips are designed to excel at multiple aspects
@@ -0,0 +1,12 @@
 .. _arm:
 ===
 Arm
 ===
 .. toctree::
    :maxdepth: 2
    overview
    arm2d
@@ -1,8 +1,8 @@
-.. _arm:
+.. _arm_overview:
-===
+========
-Arm
+Overview
-===
+========
 Arm is a leading semiconductor and software design company, renowned for creating the Cortex-M microcontroller (MCU) cores and Cortex-A/R (MPU) processor cores, which are integral to a wide range of devices. These cores are at the heart of many embedded systems, powering chips from industry giants such as STMicroelectronics, NXP, and Renesas. Arm's energy-efficient designs are used in billions of devices worldwide, from microcontrollers to smartphones and servers. By licensing their processor designs, Arm enables a broad ecosystem of partners to develop customized solutions optimized for performance, power, and size. Arm's architecture is highly compatible with various operating systems and software libraries, including LVGL, making it a versatile choice for developers creating efficient, high-performance graphical user interfaces.
@@ -0,0 +1,12 @@
 .. _espressif:
 =========
 Espressif
 =========
 .. toctree::
    :maxdepth: 2
    overview
    ppa_gpu
@@ -1,6 +1,6 @@
-=============================
+========
-Espressif (ESP32 Chip Series)
+Overview
-=============================
+========
 LVGL can be used and configured as standard `ESP-IDF <https://github.com/espressif/esp-idf>`__ component.
@@ -230,5 +230,5 @@ Limitations
 -----------
 Please notice that the PPA is at experimental level where some performance gains are expected on drawing tasks related
-to rectangle copy or filling, while for image blending, even though it is operational, there is no signifcant gains,
+to rectangle copy or filling, while for image blending, even though it is operational, there is no significant gains,
 the initial cause for that according to the PPA section from reference manual is due to the DMA-2D memory bandwidth.
@@ -0,0 +1,15 @@
 .. _chip_vendors:
 ===================
 Chip Vendor Support
 ===================
 .. toctree::
    :maxdepth: 2
    alif/index
    arm/index
    espressif/index
    nxp/index
    renesas/index
    stm32/index
@@ -30,7 +30,7 @@ please notice in this mode of operation the application is responsible to alloca
 and pass them to the display, in the example below `buffer1` and `buffer2` are the current and the next
 buffers that will be copied to the display screen, being swapped at each flush operation (managed
 internally by the display driver). Also observe, in direct mode, each buffer should have the space at
-least to hold at least the size of the screen, that is it, the heigh times the width times the bytes
+least to hold at least the size of the screen, that is it, the height times the width times the bytes
 for a pixel (which is application dependent or display supported), on the code below this size is represented
 by `buf_size`.
@@ -0,0 +1,15 @@
 .. _nxp:
 ===
 NXP
 ===
 .. toctree::
    :maxdepth: 2
    overview
    elcdif
    pxp_gpu
    vg_lite_gpu
    g2d_gpu
@@ -1,6 +1,6 @@
-===
+========
-NXP
+Overview
-===
+========
 .. |deg|    unicode:: U+000B0 .. DEGREE SIGN
@@ -0,0 +1,3 @@
 ==========
 Dave2D GPU
 ==========
@@ -13,3 +13,5 @@ Renesas
    rzg_family
    rza_family
    supported_boards
    glcdc
    dave2d_gpu
@@ -0,0 +1,15 @@
 .. _stm32:
 =====
 STM32
 =====
 .. toctree::
    :maxdepth: 2
    overview
    ltdc
    nema_gfx_gpu
    dma2d_gpu
    lcd_stm32_guide
@@ -39,7 +39,7 @@ and `lv_port_stm32u5g9j-dk2 <https://github.com/lvgl/lv_port_stm32u5g9j-dk2>`__
 is configured to link the "cortex_m33_NemaPVG" binaries when building.
 "cortex_m33_revC" works on all STM32 m33 devices with a Nema core while "cortex_m33_NemaPVG"
-additionally supports the tesselation and matrix multiplication acceleration that
+additionally supports the tessellation and matrix multiplication acceleration that
 the STM32 U5F and U5G Nema cores are capable of.
 With a different STM32CubeIDE project, you can configure the libraries to be linked
@@ -1,6 +1,6 @@
-=====
+========
-STM32
+Overview
-=====
+========
 LVGL Can be added to `STM32CubeIDE <https://www.st.com/en/development-tools/stm32cubeide.html>`__
 in a similar fashion to any other Eclipse-based IDE.
@@ -1,18 +0,0 @@
 =======
 Display
 =======
 .. toctree::
    :maxdepth: 2
    fbdev
    ft81x
    gen_mipi
    ili9341
    lcd_stm32_guide
    nxp_elcdif
    renesas_glcdc
    st_ltdc
    st7735
    st7789
    st7796
@@ -1,18 +0,0 @@
 .. _drivers:
 =======
 Drivers
 =======
 .. toctree::
    :maxdepth: 2
    display/index
    libinput
    opengles
    touchpad/index
    wayland
    windows
    X11
    uefi
    sdl
@@ -1,5 +0,0 @@
 ======
 FT6X36
 ======
 TODO
@@ -1,9 +0,0 @@
 ========
 Touchpad
 ========
 .. toctree::
    :maxdepth: 2
    evdev
    ft6x36
@@ -0,0 +1,3 @@
 ===
 DRM
 ===
@@ -1,6 +1,6 @@
-==================
+=====
-Linux Evdev Driver
+evdev
-==================
+=====
 Overview
 --------
@@ -37,8 +37,8 @@ Ensure that an ``lv_display_t`` object is already created for ``disp``. An examp
 .. code-block:: c
-    lv_display_t * disp = lv_linux_fbdev  
+    lv_display_t * disp = lv_linux_fbdev_create();
-    lv_linux_fbdev_set_file(disp, "/dev/fb0");_create();
+    lv_linux_fbdev_set_file(disp, "/dev/fb0");
 Locating your input device
@@ -1,8 +1,8 @@
 .. _opengl_es_driver:
-===============================
+====
-OpenGL ES Display/Inputs Driver
+GLFW
-===============================
+====
 Overview
 --------
--- a/Show More
+++ b/Show More