fix(docs): eliminate 2 types of sphinx warnings: (#6928)
Co-authored-by: Liam <30486941+liamHowatt@users.noreply.github.com>
This commit is contained in:
@@ -1096,7 +1096,7 @@ def iter_src(n, p):
|
|||||||
html_files[name] = html_file
|
html_files[name] = html_file
|
||||||
|
|
||||||
with open(rst_file, 'w') as f:
|
with open(rst_file, 'w') as f:
|
||||||
f.write('.. _{0}:'.format(name))
|
f.write('.. _{0}_h:'.format(name))
|
||||||
f.write('\n\n')
|
f.write('\n\n')
|
||||||
f.write('=' * len(file))
|
f.write('=' * len(file))
|
||||||
f.write('\n')
|
f.write('\n')
|
||||||
@@ -1331,7 +1331,7 @@ def run(project_path, temp_directory, *doc_paths):
|
|||||||
|
|
||||||
if html_includes:
|
if html_includes:
|
||||||
html_includes = list(
|
html_includes = list(
|
||||||
':ref:`{0}`\n'.format(inc)
|
':ref:`{0}_h`\n'.format(inc)
|
||||||
for inc, _ in html_includes
|
for inc, _ in html_includes
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -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)``.
|
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.
|
Why is the display driver called only once? Only the upper part of the display is refreshed.
|
||||||
|
|||||||
@@ -46,5 +46,5 @@ Example
|
|||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
:ref:`code128`
|
:ref:`code128_h`
|
||||||
|
|
||||||
|
|||||||
@@ -115,7 +115,7 @@ Learn more
|
|||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
:ref:`ftoption`
|
:ref:`ftoption_h`
|
||||||
|
|
||||||
:ref:`ftmodule`
|
:ref:`ftmodule_h`
|
||||||
|
|
||||||
|
|||||||
@@ -57,5 +57,5 @@ Example
|
|||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
:ref:`gifdec`
|
:ref:`gifdec_h`
|
||||||
|
|
||||||
|
|||||||
@@ -52,5 +52,5 @@ Example
|
|||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
:ref:`libjpeg_turbo`
|
:ref:`lv_libjpeg_turbo_h`
|
||||||
|
|
||||||
|
|||||||
@@ -46,5 +46,5 @@ Example
|
|||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
:ref:`lodepng`
|
:ref:`lodepng_h`
|
||||||
|
|
||||||
|
|||||||
@@ -41,5 +41,5 @@ Example
|
|||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
:ref:`qrcodegen`
|
:ref:`qrcodegen_h`
|
||||||
|
|
||||||
|
|||||||
@@ -50,6 +50,6 @@ Example
|
|||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
:ref:`stb_rect_pack`
|
:ref:`stb_rect_pack_h`
|
||||||
|
|
||||||
:ref:`stb_truetype_htcw`
|
:ref:`stb_truetype_htcw_h`
|
||||||
|
|||||||
@@ -59,8 +59,8 @@ Example
|
|||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
:ref:`lv_tjpgd`
|
:ref:`lv_tjpgd_h`
|
||||||
|
|
||||||
:ref:`tjpgd`
|
:ref:`tjpgd_h`
|
||||||
|
|
||||||
:ref:`tjpgdcnf`
|
:ref:`tjpgdcnf_h`
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ Cortex-M0 to the latest Cortex-M85.
|
|||||||
|
|
||||||
Arm-2D accelerates LVGL9 with two modes: **Synchronous Mode** and
|
Arm-2D accelerates LVGL9 with two modes: **Synchronous Mode** and
|
||||||
**Asynchronous Mode**.
|
**Asynchronous Mode**.
|
||||||
|
|
||||||
- When **Helium** and **ACI (Arm Custom Instruction)** are available, it is recommend
|
- When **Helium** and **ACI (Arm Custom Instruction)** are available, it is recommend
|
||||||
to use **Synchronous Mode** to accelerate LVGL.
|
to use **Synchronous Mode** to accelerate LVGL.
|
||||||
- When Arm-2D backed 2D-GPUs are available, for example, **DMAC-350 based 2D
|
- 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:
|
Arm-2D is an open-source project on GitHub. For more, please refer to:
|
||||||
https://github.com/ARM-software/Arm-2D.
|
https://github.com/ARM-software/Arm-2D.
|
||||||
|
|
||||||
|
|
||||||
How to Use
|
How to Use
|
||||||
**********
|
**********
|
||||||
|
|
||||||
In general:
|
In general:
|
||||||
|
|
||||||
- you can set the macro :c:macro:`LV_USE_DRAW_ARM2D_SYNC` to ``1`` and
|
- 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
|
:c:macro:`LV_DRAW_SW_ASM` to ``LV_DRAW_SW_ASM_HELIUM`` in ``lv_conf.h`` to
|
||||||
enable Arm-2D synchronous acceleration for LVGL.
|
enable Arm-2D synchronous acceleration for LVGL.
|
||||||
@@ -62,4 +65,6 @@ Examples
|
|||||||
API
|
API
|
||||||
***
|
***
|
||||||
|
|
||||||
:ref:`lv_gpu_arm2d`
|
:ref:`lv_draw_sw_arm2d_h`
|
||||||
|
|
||||||
|
:ref:`lv_blend_arm2d_h`
|
||||||
|
|||||||
@@ -5,10 +5,11 @@ NXP PXP GPU
|
|||||||
API
|
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`
|
|
||||||
|
|||||||
@@ -5,22 +5,5 @@ SDL renderer
|
|||||||
API
|
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`
|
|
||||||
|
|||||||
@@ -5,4 +5,5 @@ DMA2D GPU
|
|||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
:ref:`lv_gpu_stm32_dma2d`
|
:ref:`lv_draw_dma2d_h`
|
||||||
|
|
||||||
|
|||||||
@@ -5,10 +5,8 @@ Software renderer
|
|||||||
API
|
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`
|
|
||||||
|
|||||||
@@ -5,13 +5,13 @@ NXP VGLite GPU
|
|||||||
API
|
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`
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _timer:
|
.. _timers:
|
||||||
|
|
||||||
======
|
======
|
||||||
Timers
|
Timers
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ However, in the following conditions it's valid to call LVGL related
|
|||||||
functions:
|
functions:
|
||||||
|
|
||||||
- In *events*. Learn more in :ref:`events`.
|
- 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
|
Tasks and threads
|
||||||
-----------------
|
-----------------
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _timer:
|
.. _timer_handler:
|
||||||
|
|
||||||
=============
|
=============
|
||||||
Timer Handler
|
Timer Handler
|
||||||
@@ -52,7 +52,7 @@ In an OS environment, you can use it together with the **delay** or
|
|||||||
os_delay_ms(time_till_next); /* delay to avoid unnecessary polling */
|
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.
|
section.
|
||||||
|
|
||||||
API
|
API
|
||||||
|
|||||||
Reference in New Issue
Block a user