docs(color): fix unexpected API page links (#9338)

This commit is contained in:
Victor Wheeler
2025-12-20 00:12:25 -07:00
committed by GitHub
parent 03c43fea76
commit d2bbbcc854
3 changed files with 15 additions and 3 deletions
+4 -2
View File
@@ -391,10 +391,12 @@ API
.. API equals: lv_scale_t, lv_scale_create
.. API startswith: lv_scale, lv_obj_set_style
.. API startswith:
lv_scale
lv_obj_set_style
```
The list of symbols (or prefixes) can be separated by commas or spaces, and they can wrap onto subsequent lines of text so long as they are indented. A blank line after each list ends that list.
The list of symbols (or prefixes) can be separated by commas or spaces, and they can wrap onto subsequent lines of text so long as they are indented. Each list is terminated by the next ``.. API `` pseudo-directive or end-of-file, whichever comes first.
The API-page generation logic will add at most 1 link to each API documentation page containing matched symbols. The links are to the whole API page, not to the symbols. The purpose is to provide the reader with links to applicable API pages. Links directly to code (e.g. function documentation) are accomplished by using the In-Line Code Expressions documented above.
+1 -1
View File
@@ -342,7 +342,7 @@ def _process_end_of_eligible_doc(b: str, rst_file: str) -> (str, str, int):
links_added_count = len(genned_link_set)
if links_added_count > 0:
c = _auto_gen_sep + '\n\n'
c = '\n' + _auto_gen_sep + '\n\n'
for link_name in sorted(genned_link_set, key=_hyperlink_sort_value):
c += ':ref:`' + link_name + '`\n\n'
+10
View File
@@ -38,6 +38,7 @@ Create colors from Red, Green and Blue channel values:
/* From 3 digits. Same as lv_color_hex(0x112233) */
lv_color_t c = lv_color_hex3(0x123);
HSV
---
@@ -55,6 +56,7 @@ Create colors from Hue, Saturation and Value values:
//From lv_color_t variable
lv_color_hsv_t c_hsv = lv_color_to_hsv(color);
.. _color_palette:
Palette
@@ -95,6 +97,7 @@ For the lighter variants of a palette color use
:cpp:expr:`lv_color_t` ``c =`` :cpp:expr:`lv_palette_darken(LV_PALETTE_..., v)`. ``v`` can be
1..4.
.. _color_modify_and_mix:
Modify and mix colors
@@ -117,6 +120,7 @@ The following functions can modify a color:
// Mix two colors with a given ratio 0: full c2, 255: full c1, 128: half c1 and half c2
lv_color_t c = lv_color_mix(c1, c2, ratio);
.. _color_builtin:
Built-in colors
@@ -152,3 +156,9 @@ mixing *ratio*.
API
***
.. API equals:
lv_color_make
lv_color_mix
lv_palette_main