fix(docs): eliminate 2 types of sphinx warnings: (#6928)

Co-authored-by: Liam <30486941+liamHowatt@users.noreply.github.com>

docs/doc_builder.py

@@ -1096,7 +1096,7 @@ def iter_src(n, p):
         html_files[name] = html_file
 
         with open(rst_file, 'w') as f:
-            f.write('.. _{0}:'.format(name))
+            f.write('.. _{0}_h:'.format(name))
             f.write('\n\n')
             f.write('=' * len(file))
             f.write('\n')
@@ -1331,7 +1331,7 @@ def run(project_path, temp_directory, *doc_paths):
 
             if html_includes:
                 html_includes = list(
-                    ':ref:`{0}`\n'.format(inc)
+                    ':ref:`{0}_h`\n'.format(inc)
                     for inc, _ in html_includes
                 )
 

docs/intro/index.rst

@@ -212,7 +212,7 @@ My display driver is not called. What have I missed?
 
 Be sure you are calling :cpp:expr:`lv_tick_inc(x)` in an interrupt and :cpp:func:`lv_timer_handler` in your main ``while(1)``.
 
-Learn more in the :ref:`tick` and :ref:`timer` sections.
+Learn more in the :ref:`tick` and :ref:`timer_handler` sections.
 
 
 Why is the display driver called only once? Only the upper part of the display is refreshed.

docs/libs/barcode.rst

@@ -20,8 +20,8 @@ Use :cpp:func:`lv_barcode_create` to create a barcode object, and use
 
 Call :cpp:func:`lv_barcode_set_scale` to adjust scaling,
 call :cpp:func:`lv_barcode_set_dark_color` and :cpp:func:`lv_barcode_set_light_color`
-adjust color, call :cpp:func:`lv_barcode_set_direction` will set 
+adjust color, call :cpp:func:`lv_barcode_set_direction` will set
-direction to display, and call :cpp:func:`lv_barcode_update` again to regenerate 
+direction to display, and call :cpp:func:`lv_barcode_update` again to regenerate
 the barcode.
 
 Notes
@@ -46,5 +46,5 @@ Example
 API
 ---
 
-:ref:`code128`
+:ref:`code128_h`
 

docs/libs/freetype.rst

@@ -115,7 +115,7 @@ Learn more
 API
 ---
 
-:ref:`ftoption`
+:ref:`ftoption_h`
 
-:ref:`ftmodule`
+:ref:`ftmodule_h`
 

docs/libs/gif.rst

@@ -39,7 +39,7 @@ Memory requirements
 -------------------
 
 To decode and display a GIF animation the following amount of RAM is
-required: 
+required:
 
 - :c:macro:`LV_COLOR_DEPTH` ``8``: 3 x image width x image height
 - :c:macro:`LV_COLOR_DEPTH` ``16``: 4 x image width x image height
@@ -57,5 +57,5 @@ Example
 API
 ---
 
-:ref:`gifdec`
+:ref:`gifdec_h`
 

docs/libs/libjpeg_turbo.rst

@@ -4,7 +4,7 @@
 libjpeg-turbo decoder
 =====================
 
-**libjpeg-turbo** is a JPEG image codec that uses SIMD instructions to accelerate baseline JPEG compression and decompression on x86, 
+**libjpeg-turbo** is a JPEG image codec that uses SIMD instructions to accelerate baseline JPEG compression and decompression on x86,
 x86-64, Arm, PowerPC, and MIPS systems, as well as progressive JPEG compression on x86, x86-64, and Arm systems.
 
 Detailed introduction: https://libjpeg-turbo.org
@@ -37,7 +37,7 @@ Usage
 Enable :c:macro:`LV_USE_LIBJPEG_TURBO` in ``lv_conf.h``.
 
 See the examples below.
-It should be noted that each image of this decoder needs to consume ``image width x image height x 3`` bytes of RAM, 
+It should be noted that each image of this decoder needs to consume ``image width x image height x 3`` bytes of RAM,
 and it needs to be combined with the :ref:`overview_image_caching` feature to ensure that the memory usage is within a reasonable range.
 
 .. _libjpeg_example:
@@ -52,5 +52,5 @@ Example
 API
 ---
 
-:ref:`libjpeg_turbo`
+:ref:`lv_libjpeg_turbo_h`
 

docs/libs/lodepng.rst

@@ -46,5 +46,5 @@ Example
 API
 ---
 
-:ref:`lodepng`
+:ref:`lodepng_h`
 

docs/libs/qrcode.rst

@@ -19,7 +19,7 @@ Use :cpp:func:`lv_qrcode_create` to create a qrcode object, and use
 :cpp:func:`lv_qrcode_update` to generate a QR code.
 
 If you need to re-modify the size and color, use
-:cpp:func:`lv_qrcode_set_size` and :cpp:func:`lv_qrcode_set_dark_color` or 
+:cpp:func:`lv_qrcode_set_size` and :cpp:func:`lv_qrcode_set_dark_color` or
 :cpp:func:`lv_qrcode_set_light_color`, and
 call :cpp:func:`lv_qrcode_update` again to regenerate the QR code.
 
@@ -41,5 +41,5 @@ Example
 API
 ---
 
-:ref:`qrcodegen`
+:ref:`qrcodegen_h`
 

docs/libs/tiny_ttf.rst

@@ -50,6 +50,6 @@ Example
 API
 ---
 
-:ref:`stb_rect_pack`
+:ref:`stb_rect_pack_h`
 
-:ref:`stb_truetype_htcw`
+:ref:`stb_truetype_htcw_h`

docs/libs/tjpgd.rst

@@ -59,8 +59,8 @@ Example
 API
 ---
 
-:ref:`lv_tjpgd`
+:ref:`lv_tjpgd_h`
 
-:ref:`tjpgd`
+:ref:`tjpgd_h`
 
-:ref:`tjpgdcnf`
+:ref:`tjpgdcnf_h`

docs/overview/renderers/arm2d.rst

@@ -10,6 +10,7 @@ Cortex-M0 to the latest Cortex-M85.
 
 Arm-2D accelerates LVGL9 with two modes: **Synchronous Mode** and
 **Asynchronous Mode**.
+
 - When **Helium** and **ACI (Arm Custom Instruction)** are available, it is recommend
   to use **Synchronous Mode** to accelerate LVGL.
 - When Arm-2D backed 2D-GPUs are available, for example, **DMAC-350 based 2D
@@ -18,10 +19,12 @@ Arm-2D accelerates LVGL9 with two modes: **Synchronous Mode** and
 Arm-2D is an open-source project on GitHub. For more, please refer to:
 https://github.com/ARM-software/Arm-2D.
 
+
 How to Use
 **********
 
 In general:
+
 - you can set the macro :c:macro:`LV_USE_DRAW_ARM2D_SYNC` to ``1`` and
   :c:macro:`LV_DRAW_SW_ASM` to ``LV_DRAW_SW_ASM_HELIUM`` in ``lv_conf.h`` to
   enable Arm-2D synchronous acceleration for LVGL.
@@ -62,4 +65,6 @@ Examples
 API
 ***
 
-:ref:`lv_gpu_arm2d`
+:ref:`lv_draw_sw_arm2d_h`
+
+:ref:`lv_blend_arm2d_h`

docs/overview/renderers/pxp.rst

@@ -5,10 +5,11 @@ NXP PXP GPU
 API
 ---
 
-:ref:`lv_draw_pxp`
+:ref:`lv_draw_pxp_h`
 
-:ref:`lv_draw_pxp_blend`
+:ref:`lv_pxp_cfg_h`
 
-:ref:`lv_gpu_nxp_pxp`
+:ref:`lv_pxp_osa_h`
+
+:ref:`lv_pxp_utils_h`
 
-:ref:`lv_gpu_nxp_pxp_osa`

docs/overview/renderers/sdl.rst

@@ -5,22 +5,5 @@ SDL renderer
 API
 ---
 
-:ref:`lv_draw_sdl`
+:ref:`lv_draw_sdl_h`
 
-:ref:`lv_draw_sdl_composite`
-
-:ref:`lv_draw_sdl_img`
-
-:ref:`lv_draw_sdl_layer`
-
-:ref:`lv_draw_sdl_mask`
-
-:ref:`lv_draw_sdl_priv`
-
-:ref:`lv_draw_sdl_rect`
-
-:ref:`lv_draw_sdl_stack_blur`
-
-:ref:`lv_draw_sdl_texture_cache`
-
-:ref:`lv_draw_sdl_utils`

docs/overview/renderers/stm32_dma2d.rst

@@ -5,4 +5,5 @@ DMA2D GPU
 API
 ---
 
-:ref:`lv_gpu_stm32_dma2d`
+:ref:`lv_draw_dma2d_h`
+

docs/overview/renderers/sw.rst

@@ -5,10 +5,8 @@ Software renderer
 API
 ---
 
-:ref:`lv_draw_sw`
+:ref:`lv_draw_sw_h`
 
-:ref:`lv_draw_sw_blend`
+:ref:`lv_draw_sw_blend_h`
 
-:ref:`lv_draw_sw_dither`
+:ref:`lv_draw_sw_gradient_h`
-
-:ref:`lv_draw_sw_gradient`

docs/overview/renderers/vglite.rst

@@ -5,13 +5,13 @@ NXP VGLite GPU
 API
 ---
 
-:ref:`lv_draw_vglite`
+:ref:`lv_draw_vglite_h`
 
-:ref:`lv_draw_vglite_arc`
+:ref:`lv_vglite_buf_h`
 
-:ref:`lv_draw_vglite_blend`
+:ref:`lv_vglite_matrix_h`
 
-:ref:`lv_draw_vglite_line`
+:ref:`lv_vglite_path_h`
 
-:ref:`lv_draw_vglite_rect`
+:ref:`lv_vglite_utils_h`
 

docs/overview/timer.rst

@@ -1,4 +1,4 @@
-.. _timer:
+.. _timers:
 
 ======
 Timers

docs/porting/os.rst

@@ -10,7 +10,7 @@ However, in the following conditions it's valid to call LVGL related
 functions:
 
 - In *events*. Learn more in :ref:`events`.
-- In *lv_timer*. Learn more in :ref:`timer`.
+- In *lv_timer*. Learn more in :ref:`timers`.
 
 Tasks and threads
 -----------------

docs/porting/timer_handler.rst

@@ -1,4 +1,4 @@
-.. _timer:
+.. _timer_handler:
 
 =============
 Timer Handler
@@ -48,11 +48,11 @@ In an OS environment, you can use it together with the **delay** or
 .. code:: c
 
    while (1) {
-      uint32_t time_till_next = lv_timer_handler(); 
+      uint32_t time_till_next = lv_timer_handler();
       os_delay_ms(time_till_next); /* delay to avoid unnecessary polling */
    }
 
-To learn more about timers visit the :ref:`timer`
+To learn more about timers visit the :ref:`timers`
 section.
 
 API