docs(examples): make example_list.py robust (#9317)

docs/announce.py

@@ -25,7 +25,7 @@ It is the designer's intention that:
 import os
 import datetime
 
-__all__ = ('announce', 'announce_colored', 'announce_start', 'announce_finish', 'announce_set_silent_mode')
+__all__ = ('announce', 'announce_colored', 'announce_start', 'announce_finish', 'announce_set_silent_mode', 'is_silent_mode')
 _announce_start_time: datetime.datetime
 _announce_silent_mode: bool = False
 _console_color_commands = {
@@ -116,3 +116,8 @@ def announce_finish():
 def announce_set_silent_mode(mode=True):
     global _announce_silent_mode
     _announce_silent_mode = mode
+
+
+def is_silent_mode(mode=True):
+    global _announce_silent_mode
+    return _announce_silent_mode

docs/build.py

@@ -610,6 +610,7 @@ def run(args):
         # in individual documents where applicable.
         # -----------------------------------------------------------------
         announce(__file__, "Generating examples...")
+        example_list.make_warnings_into_errors()
         example_list.exec(intermediate_dir)
 
         # -----------------------------------------------------------------

examples/README.md

@@ -0,0 +1,98 @@
+# Examples Directory Requirements
+
+```
+lvgl/examples/
+    index.rst        (directory-order directive since sub-dirs
+                     are not presented in alphabetical order)
+    anim/
+        index.rst    (see below for expected contents)
+        lv_example_anim_1.c
+        lv_example_anim_2.c
+        lv_example_anim_3.c
+        lv_example_anim_4.c
+        lv_example_anim_timeline_1.c
+    ...
+    layouts/
+        flex/
+            index.rst    (see below for expected contents)
+            lv_example_flex_1.c
+            lv_example_flex_2.c
+            lv_example_flex_3.c
+            etc.
+        grid/
+            etc.
+    libs/
+        index.rst        (section-heading name: "3rd-Party Libraries"
+                         [since it is different than parent directory name])
+        barcode/
+            index.rst    (see below for expected contents)
+            lv_example_barcode_1.c
+            lv_example_barcode_1.h
+        bmp/
+            etc.
+        etc.
+    etc.
+```
+
+
+## index.rst Requirements
+
+```
+Example 1 Title  <-- required for each example
+---------------  <-- required for each example
+                                    <-- blank lines are ignored
+.. lv_example:: lv_example_anim_1   <-- relative path to stem of C filename
+    :language: c
+```
+
+Repeat the above pattern for each example in current directory.  That number may be zero (0) for directories like `libs/` in which all examples are in directories below that level.  See directory structure above.
+
+Provide relative paths to each example outside of the current directory, e.g. some examples use 2 Widgets, so the example would be local to one `index.rst`, and provide a relative path from the other.  Example from `lvgl/examples/widgets/scale/index.rst`:
+
+```
+...
+
+Axis ticks and labels with scrolling on a chart
+-----------------------------------------------
+.. lv_example:: ../chart/lv_example_chart_2
+  :language: c
+```
+
+#### Note
+
+Starting the example code filename with `lv_example_` is not a requirement of the `example_list.py` script, but does make it clear that it is an example, so this pattern should be preserved for new and changed examples.
+
+
+### Custom Section Headings
+
+If a section heading needs to be spelled differently than the capitalized name of the parent directory, then an `index.rst` file in that directory may contain the desired section-heading name underscored with asterisks (\*).  Example from `lvgl/examples/libs/index.rst`:
+
+```
+3rd-Party Libraries
+*******************
+```
+
+
+### Optional Directory Reordering
+
+There are cases where it is not appropriate to present the contents of a directory in alphabetical order.  When this is the case, a directive in the `index.rst` file in the parent directory can be specified to govern the sequence its subdirectories are processed.  The example below is from `lvgl/examples/widgets/index.rst`.  It is provided in order to cause the "Base Widget" (obj) directory to be processed first.
+
+```rst
+.. dir_order::
+
+    obj
+    animimg
+    arc
+    arclabel
+    bar
+    button
+    buttonmatrix
+    etc.
+```
+
+#### Note
+
+A warning is issued if either:
+
+- a subdirectory is named that does not exist, or
+- a subdirectory exists that is not in the list and not in the `avoid_dirs` list.

examples/anim/index.rst

@@ -1,27 +1,29 @@
+Animations
+**********
 
 Start animation on an event
 ---------------------------
 
-.. lv_example:: anim/lv_example_anim_1
+.. lv_example:: lv_example_anim_1
   :language: c
 
 Playback animation
 ------------------
-.. lv_example:: anim/lv_example_anim_2
+.. lv_example:: lv_example_anim_2
   :language: c
 
 Cubic Bezier animation
 ----------------------
-.. lv_example:: anim/lv_example_anim_3
+.. lv_example:: lv_example_anim_3
   :language: c
 
 Pause animation
 ----------------------
-.. lv_example:: anim/lv_example_anim_4
+.. lv_example:: lv_example_anim_4
   :language: c
 
 Animation timeline
 ------------------
-.. lv_example:: anim/lv_example_anim_timeline_1
+.. lv_example:: lv_example_anim_timeline_1
   :language: c
 

examples/event/index.rst

@@ -1,35 +1,37 @@
+Events
+******
 
 Button click event
 ------------------
 
-.. lv_example:: event/lv_example_event_click
+.. lv_example:: lv_example_event_click
   :language: c
 
 Click streaks
 -------------
 
-.. lv_example:: event/lv_example_event_streak
+.. lv_example:: lv_example_event_streak
   :language: c
 
 Handle multiple events
 ----------------------
-.. lv_example:: event/lv_example_event_button
+.. lv_example:: lv_example_event_button
   :language: c
 
 
 Event bubbling
 --------------
-.. lv_example:: event/lv_example_event_bubble
+.. lv_example:: lv_example_event_bubble
   :language: c
 
 Event trickle-down
 ------------------
-.. lv_example:: event/lv_example_event_trickle
+.. lv_example:: lv_example_event_trickle
   :language: c
 
 Draw event
 ----------
-.. lv_example:: event/lv_example_event_draw
+.. lv_example:: lv_example_event_draw
   :language: c
 
 

examples/get_started/index.rst

@@ -1,24 +1,27 @@
+Getting Started
+***************
+
 
 A very simple *hello world* label
 ---------------------------------
 
-.. lv_example:: get_started/lv_example_get_started_1
+.. lv_example:: lv_example_get_started_1
   :language: c
 
 A button with a label and react on click event
 ----------------------------------------------
 
-.. lv_example:: get_started/lv_example_get_started_2
+.. lv_example:: lv_example_get_started_2
   :language: c
 
 Create styles from scratch for buttons
 --------------------------------------
-.. lv_example:: get_started/lv_example_get_started_3
+.. lv_example:: lv_example_get_started_3
   :language: c
 
 Create a slider and write its value on a label
 ----------------------------------------------
-.. lv_example:: get_started/lv_example_get_started_4
+.. lv_example:: lv_example_get_started_4
   :language: c
 
 

examples/grad/index.rst

@@ -1,23 +1,27 @@
+Gradients
+*********
+
+
 Simple Horizontal Gradient
 --------------------------
 
-.. lv_example:: grad/lv_example_grad_1
+.. lv_example:: lv_example_grad_1
   :language: c
 
 Linear (Skew) Gradient
 ----------------------
 
-.. lv_example:: grad/lv_example_grad_2
+.. lv_example:: lv_example_grad_2
   :language: c
 
 Radial Gradient
 ---------------
 
-.. lv_example:: grad/lv_example_grad_3
+.. lv_example:: lv_example_grad_3
   :language: c
 
 Conical Gradient
 ----------------
 
-.. lv_example:: grad/lv_example_grad_4
+.. lv_example:: lv_example_grad_4
   :language: c

examples/index.rst

@@ -0,0 +1,13 @@
+.. dir_order::
+
+    get_started
+    styles
+    grad
+    anim
+    event
+    layouts
+    scroll
+    widgets
+    libs
+    others
+    porting

examples/layouts/flex/index.rst

@@ -1,37 +1,37 @@
 A simple row and a column layout with flexbox
 ---------------------------------------------
 
-.. lv_example:: layouts/flex/lv_example_flex_1
+.. lv_example:: lv_example_flex_1
   :language: c
 
 Arrange items in rows with wrap and even spacing
 ------------------------------------------------
 
-.. lv_example:: layouts/flex/lv_example_flex_2
+.. lv_example:: lv_example_flex_2
   :language: c
 
 Demonstrate flex grow
 ---------------------
 
-.. lv_example:: layouts/flex/lv_example_flex_3
+.. lv_example:: lv_example_flex_3
   :language: c
 
-Demonstrate flex grow.
-----------------------
+Demonstrate flex grow
+---------------------
 
-.. lv_example:: layouts/flex/lv_example_flex_4
+.. lv_example:: lv_example_flex_4
   :language: c
 
 Demonstrate column and row gap style properties
 -----------------------------------------------
 
-.. lv_example:: layouts/flex/lv_example_flex_5
+.. lv_example:: lv_example_flex_5
   :language: c
 
 RTL base direction changes order of the items
 ---------------------------------------------
 
-.. lv_example:: layouts/flex/lv_example_flex_6
+.. lv_example:: lv_example_flex_6
   :language: c
 
 

examples/layouts/grid/index.rst

@@ -1,37 +1,37 @@
 A simple grid
 -------------
 
-.. lv_example:: layouts/grid/lv_example_grid_1
+.. lv_example:: lv_example_grid_1
   :language: c
 
 Demonstrate cell placement and span
 -----------------------------------
 
-.. lv_example:: layouts/grid/lv_example_grid_2
+.. lv_example:: lv_example_grid_2
   :language: c
 
 Demonstrate grid's -free unit-
 ------------------------------
 
-.. lv_example:: layouts/grid/lv_example_grid_3
+.. lv_example:: lv_example_grid_3
   :language: c
 
 Demonstrate track placement
 ---------------------------
 
-.. lv_example:: layouts/grid/lv_example_grid_4
+.. lv_example:: lv_example_grid_4
   :language: c
 
 Demonstrate column and row gap
 ------------------------------
 
-.. lv_example:: layouts/grid/lv_example_grid_5
+.. lv_example:: lv_example_grid_5
   :language: c
 
 Demonstrate RTL direction on grid
 ---------------------------------
 
-.. lv_example:: layouts/grid/lv_example_grid_6
+.. lv_example:: lv_example_grid_6
   :language: c
 
 

examples/libs/barcode/index.rst

@@ -1,6 +1,6 @@
 Create a Barcode
 ----------------
 
-.. lv_example:: libs/barcode/lv_example_barcode_1
+.. lv_example:: lv_example_barcode_1
   :language: c
 

examples/libs/bmp/index.rst

@@ -1,6 +1,10 @@
+BMP
+***
+
+
 Open a BMP image from file
 --------------------------
 
-.. lv_example:: libs/bmp/lv_example_bmp_1
+.. lv_example:: lv_example_bmp_1
   :language: c
 

examples/libs/ffmpeg/index.rst

@@ -1,12 +1,16 @@
+FFmpeg
+******
+
+
 Decode image
 ------------
 
-.. lv_example:: libs/ffmpeg/lv_example_ffmpeg_1
+.. lv_example:: lv_example_ffmpeg_1
   :language: c
 
 Decode video
 ------------
 
-.. lv_example:: libs/ffmpeg/lv_example_ffmpeg_2
+.. lv_example:: lv_example_ffmpeg_2
   :language: c
 

examples/libs/freetype/index.rst

@@ -1,17 +1,21 @@
+FreeType
+********
+
+
 Create a font with FreeType
 ---------------------------
 
-.. lv_example:: libs/freetype/lv_example_freetype_1
+.. lv_example:: lv_example_freetype_1
   :language: c
 
 Use a bitmap font to draw Emojis using FreeType
 -----------------------------------------------
 
-.. lv_example:: libs/freetype/lv_example_freetype_2
+.. lv_example:: lv_example_freetype_2
   :language: c
 
 Freetype font kerning
 ---------------------
 
-.. lv_example:: libs/freetype/lv_example_freetype_3
+.. lv_example:: lv_example_freetype_3
   :language: c

examples/libs/gif/index.rst

@@ -1,6 +1,10 @@
+GIF
+***
+
+
 Open a GIF image from file and variable
 ---------------------------------------
 
-.. lv_example:: libs/gif/lv_example_gif_1
+.. lv_example:: lv_example_gif_1
   :language: c
 

examples/libs/gltf/index.rst

@@ -1,14 +1,18 @@
+glTF
+****
+
+
 Open a glTF from a file and make it spin forever like a platter
 ---------------------------------------------------------------
 
-.. lv_example:: libs/gltf/lv_example_gltf_1
+.. lv_example:: lv_example_gltf_1
   :language: c
 
 
 Open a glTF from a file and iterate through each camera
 -------------------------------------------------------
 
-.. lv_example:: libs/gltf/lv_example_gltf_2
+.. lv_example:: lv_example_gltf_2
   :language: c
 
 Load multiple models in a single glTF object and modify their position, rotation and scale at runtime

examples/libs/gstreamer/index.rst

@@ -1,5 +1,9 @@
+GStreamer
+*********
+
+
 Loads a video from the internet using the gstreamer widget
 ----------------------------------------------------------
 
-.. lv_example:: libs/gstreamer/lv_example_gstreamer_1
+.. lv_example:: lv_example_gstreamer_1
   :language: c

examples/libs/index.rst

@@ -0,0 +1,2 @@
+3rd-Party Libraries
+*******************

examples/libs/libjpeg_turbo/index.rst

@@ -1,6 +1,10 @@
+libjpeg-turbo
+*************
+
+
 Load a JPG image
 -----------------
 
-.. lv_example:: libs/libjpeg_turbo/lv_example_libjpeg_turbo_1
+.. lv_example:: lv_example_libjpeg_turbo_1
   :language: c
 

examples/libs/libpng/index.rst

@@ -1,6 +1,10 @@
+libpng
+******
+
+
 Open a PNG image from file and variable
 ---------------------------------------
 
-.. lv_example:: libs/libpng/lv_example_libpng_1
+.. lv_example:: lv_example_libpng_1
   :language: c
 

examples/libs/libwebp/index.rst

@@ -1,6 +1,10 @@
+LibWebP
+*******
+
+
 Open a WEBP image from file and variable
 ----------------------------------------
 
-.. lv_example:: libs/libwebp/lv_example_libwebp_1
+.. lv_example:: lv_example_libwebp_1
   :language: c
 

examples/libs/lodepng/index.rst

@@ -1,6 +1,10 @@
+LodePNG
+*******
+
+
 Open a PNG image from file and variable
 ---------------------------------------
 
-.. lv_example:: libs/lodepng/lv_example_lodepng_1
+.. lv_example:: lv_example_lodepng_1
   :language: c
 

examples/libs/qrcode/index.rst

@@ -1,6 +1,10 @@
+QR-Code Generator
+*****************
+
+
 Create a QR Code
 ----------------
 
-.. lv_example:: libs/qrcode/lv_example_qrcode_1
+.. lv_example:: lv_example_qrcode_1
   :language: c
 

examples/libs/rlottie/index.rst

@@ -1,12 +1,16 @@
+rlottie
+*******
+
+
 Load a Lottie animation from raw data
 -------------------------------------
 
-.. lv_example:: libs/rlottie/lv_example_rlottie_1
+.. lv_example:: lv_example_rlottie_1
   :language: c
 
 Load a Lottie animation from a file
 -----------------------------------
 
-.. lv_example:: libs/rlottie/lv_example_rlottie_2
+.. lv_example:: lv_example_rlottie_2
   :language: c
 

examples/libs/svg/index.rst

@@ -1,17 +1,21 @@
+SVG
+***
+
+
 Load and render SVG data
 ------------------------
 
-.. lv_example:: libs/svg/lv_example_svg_1
+.. lv_example:: lv_example_svg_1
   :language: c
 
 Load and render SVG data from a file
 ------------------------------------
 
-.. lv_example:: libs/svg/lv_example_svg_2
+.. lv_example:: lv_example_svg_2
   :language: c
 
 Load and render SVG data in a draw event
 ----------------------------------------
 
-.. lv_example:: libs/svg/lv_example_svg_3
+.. lv_example:: lv_example_svg_3
   :language: c

examples/libs/tiny_ttf/index.rst

@@ -1,18 +1,22 @@
+Tiny TTF
+********
+
+
 Open a font with Tiny TTF from data array
 ------------------------------------------
 
-.. lv_example:: libs/tiny_ttf/lv_example_tiny_ttf_1
+.. lv_example:: lv_example_tiny_ttf_1
   :language: c
 
 
 Load a font with Tiny_TTF from file
 -----------------------------------
 
-.. lv_example:: libs/tiny_ttf/lv_example_tiny_ttf_2
+.. lv_example:: lv_example_tiny_ttf_2
   :language: c
 
 Change font size with Tiny_TTF
 ------------------------------
 
-.. lv_example:: libs/tiny_ttf/lv_example_tiny_ttf_3
+.. lv_example:: lv_example_tiny_ttf_3
   :language: c

examples/libs/tjpgd/index.rst

@@ -1,6 +1,10 @@
+Tiny JPEG Decompressor (TJpgDec)
+********************************
+
+
 Load a JPG image
 ------------------
 
-.. lv_example:: libs/tjpgd/lv_example_tjpgd_1
+.. lv_example:: lv_example_tjpgd_1
   :language: c
 

examples/others/file_explorer/index.rst

@@ -2,17 +2,17 @@
 Simple File Explorer
 --------------------
 
-.. lv_example:: others/file_explorer/lv_example_file_explorer_1
+.. lv_example:: lv_example_file_explorer_1
   :language: c
 
 Control File Explorer
 ---------------------
 
-.. lv_example:: others/file_explorer/lv_example_file_explorer_2
+.. lv_example:: lv_example_file_explorer_2
   :language: c
 
 Custom sort
 -----------
 
-.. lv_example:: others/file_explorer/lv_example_file_explorer_3
+.. lv_example:: lv_example_file_explorer_3
   :language: c

examples/others/font_manager/index.rst

@@ -2,17 +2,17 @@
 Create FreeType Font
 --------------------
 
-.. lv_example:: others/font_manager/lv_example_font_manager_1
+.. lv_example:: lv_example_font_manager_1
   :language: c
 
 Create Font Family
 ------------------
 
-.. lv_example:: others/font_manager/lv_example_font_manager_2
+.. lv_example:: lv_example_font_manager_2
   :language: c
 
 Create Custom Image Font
 ------------------------
 
-.. lv_example:: others/font_manager/lv_example_font_manager_3
+.. lv_example:: lv_example_font_manager_3
   :language: c

examples/others/fragment/index.rst

@@ -1,12 +1,15 @@
+Fragment Manager
+****************
+
 
 Basic fragment usage
 --------------------
 
-.. lv_example:: others/fragment/lv_example_fragment_1
+.. lv_example:: lv_example_fragment_1
   :language: c
 
 Stack navigation example
 ------------------------
 
-.. lv_example:: others/fragment/lv_example_fragment_2
+.. lv_example:: lv_example_fragment_2
   :language: c

examples/others/gridnav/index.rst

@@ -1,30 +1,33 @@
+Grid Navigation
+***************
+
 
 Basic grid navigation
 ---------------------
 
-.. lv_example:: others/gridnav/lv_example_gridnav_1
+.. lv_example:: lv_example_gridnav_1
   :language: c
 
 Grid navigation on a list
 -------------------------
 
-.. lv_example:: others/gridnav/lv_example_gridnav_2
+.. lv_example:: lv_example_gridnav_2
   :language: c
 
 Nested grid navigations
 -----------------------
 
-.. lv_example:: others/gridnav/lv_example_gridnav_3
+.. lv_example:: lv_example_gridnav_3
   :language: c
 
 Simple navigation on a list widget
 ----------------------------------
 
-.. lv_example:: others/gridnav/lv_example_gridnav_4
+.. lv_example:: lv_example_gridnav_4
   :language: c
 
 Grid navigation for only one axis
 ---------------------------------
 
-.. lv_example:: others/gridnav/lv_example_gridnav_5
+.. lv_example:: lv_example_gridnav_5
   :language: c

examples/others/ime/index.rst

@@ -1,12 +1,15 @@
+Pinyin IME
+**********
+
 
 Pinyin IME 26 key input
 -----------------------
 
-.. lv_example:: others/ime/lv_example_ime_pinyin_1
+.. lv_example:: lv_example_ime_pinyin_1
   :language: c
 
 Pinyin IME 9 key input
 ----------------------
 
-.. lv_example:: others/ime/lv_example_ime_pinyin_2
+.. lv_example:: lv_example_ime_pinyin_2
   :language: c

examples/others/imgfont/index.rst

@@ -1,6 +1,10 @@
+Image Font
+**********
+
+
 Use emojis in a text.
 ---------------------
 
-.. lv_example:: others/imgfont/lv_example_imgfont_1
+.. lv_example:: lv_example_imgfont_1
   :language: c
 

examples/others/monkey/index.rst

@@ -2,17 +2,17 @@
 Touchpad monkey example
 -----------------------
 
-.. lv_example:: others/monkey/lv_example_monkey_1
+.. lv_example:: lv_example_monkey_1
   :language: c
 
 Encoder monkey example
 ----------------------
 
-.. lv_example:: others/monkey/lv_example_monkey_2
+.. lv_example:: lv_example_monkey_2
   :language: c
 
 Button monkey example
 ---------------------
 
-.. lv_example:: others/monkey/lv_example_monkey_3
+.. lv_example:: lv_example_monkey_3
   :language: c

examples/others/observer/index.rst

@@ -2,37 +2,37 @@
 Bind a slider's value to a label
 --------------------------------
 
-.. lv_example:: others/observer/lv_example_observer_1
+.. lv_example:: lv_example_observer_1
   :language: c
 
 Handling login and its states
 -----------------------------
 
-.. lv_example:: others/observer/lv_example_observer_2
+.. lv_example:: lv_example_observer_2
   :language: c
 
 Set time with 12/24 mode and AM/PM
 ----------------------------------
 
-.. lv_example:: others/observer/lv_example_observer_3
+.. lv_example:: lv_example_observer_3
   :language: c
 
 Custom tab view with state management
 -------------------------------------
 
-.. lv_example:: others/observer/lv_example_observer_4
+.. lv_example:: lv_example_observer_4
   :language: c
 
 Firmware update process
 -----------------------
 
-.. lv_example:: others/observer/lv_example_observer_5
+.. lv_example:: lv_example_observer_5
   :language: c
 
 Modular style update on theme change
 ------------------------------------
 
-.. lv_example:: others/observer/lv_example_observer_6
+.. lv_example:: lv_example_observer_6
   :language: c
 
 

examples/others/snapshot/index.rst

@@ -1,7 +1,7 @@
 Simple snapshot example
 -----------------------
 
-.. lv_example:: others/snapshot/lv_example_snapshot_1
+.. lv_example:: lv_example_snapshot_1
   :language: c
 
 

examples/others/translation/index.rst

@@ -1,13 +1,13 @@
 Simple translation example
 ---------------------------
 
-.. lv_example:: others/translation/lv_example_translation_1
+.. lv_example:: lv_example_translation_1
   :language: c
 
 Dynamic language selection
 --------------------------
 
-.. lv_example:: others/translation/lv_example_translation_2
+.. lv_example:: lv_example_translation_2
   :language: c
 
 

examples/others/xml/index.rst

@@ -1,8 +1,12 @@
+XML Components
+**************
+
+
 Load components at runtime
 --------------------------
 
-.. lv_example:: others/xml/lv_example_xml_1
+.. lv_example:: lv_example_xml_1
   :language: c
 
-.. lv_example:: others/xml/lv_example_xml_2
+.. lv_example:: lv_example_xml_2
   :language: c

examples/porting/osal/index.rst

@@ -1,7 +1,10 @@
+OS Abstraction Layer (OSAL)
+***************************
+
 
 Basic Example
 -------------
 
-.. lv_example:: porting/osal/lv_example_osal
+.. lv_example:: lv_example_osal
   :language: c
 

examples/scroll/index.rst

@@ -1,48 +1,50 @@
+Scrolling
+*********
 
 Nested scrolling
 ----------------
 
-.. lv_example:: scroll/lv_example_scroll_1
+.. lv_example:: lv_example_scroll_1
   :language: c
 
 Snapping
 --------
-.. lv_example:: scroll/lv_example_scroll_2
+.. lv_example:: lv_example_scroll_2
   :language: c
 
 Floating button
 ----------------
-.. lv_example:: scroll/lv_example_scroll_3
+.. lv_example:: lv_example_scroll_3
   :language: c
 
 Styling the scrollbars
 ----------------------
-.. lv_example:: scroll/lv_example_scroll_4
+.. lv_example:: lv_example_scroll_4
   :language: c
 
 Right to left scrolling
 -----------------------
-.. lv_example:: scroll/lv_example_scroll_5
+.. lv_example:: lv_example_scroll_5
   :language: c
 
 Translate on scroll
 -------------------
-.. lv_example:: scroll/lv_example_scroll_6
+.. lv_example:: lv_example_scroll_6
   :language: c
 
 Infinite scrolling
 ------------------
-.. lv_example:: scroll/lv_example_scroll_7
+.. lv_example:: lv_example_scroll_7
   :language: c
   
 Circular scrolling
 ------------------
-.. lv_example:: scroll/lv_example_scroll_8
+.. lv_example:: lv_example_scroll_8
   :language: c
 
 Scrolling Properties
 --------------------
-.. lv_example:: scroll/lv_example_scroll_9
+.. lv_example:: lv_example_scroll_9
   :language: c
 
 

examples/styles/index.rst

@@ -2,120 +2,120 @@
 Size styles
 -----------
 
-.. lv_example:: styles/lv_example_style_1
+.. lv_example:: lv_example_style_1
   :language: c
 
 Background styles
 -----------------
 
-.. lv_example:: styles/lv_example_style_2
+.. lv_example:: lv_example_style_2
   :language: c
 
 Border styles
 -------------
 
-.. lv_example:: styles/lv_example_style_3
+.. lv_example:: lv_example_style_3
   :language: c
 
 Outline styles
 --------------
 
-.. lv_example:: styles/lv_example_style_4
+.. lv_example:: lv_example_style_4
   :language: c
 
 Shadow styles
 -------------
 
-.. lv_example:: styles/lv_example_style_5
+.. lv_example:: lv_example_style_5
   :language: c
 
 Image styles
 ------------
 
-.. lv_example:: styles/lv_example_style_6
+.. lv_example:: lv_example_style_6
   :language: c
 
 Arc styles
 ----------
 
-.. lv_example:: styles/lv_example_style_7
+.. lv_example:: lv_example_style_7
   :language: c
 
 Text styles
 -----------
 
-.. lv_example:: styles/lv_example_style_8
+.. lv_example:: lv_example_style_8
   :language: c
 
 Line styles
 -----------
 
-.. lv_example:: styles/lv_example_style_9
+.. lv_example:: lv_example_style_9
   :language: c
 
 Transition
 ----------
 
-.. lv_example:: styles/lv_example_style_10
+.. lv_example:: lv_example_style_10
   :language: c
 
 Using multiple styles
 ---------------------
 
-.. lv_example:: styles/lv_example_style_11
+.. lv_example:: lv_example_style_11
   :language: c
 
 Local styles
 ------------
 
-.. lv_example:: styles/lv_example_style_12
+.. lv_example:: lv_example_style_12
   :language: c
 
 Add styles to parts and states
 ------------------------------
 
-.. lv_example:: styles/lv_example_style_13
+.. lv_example:: lv_example_style_13
   :language: c
 
 Extending the current theme
 ---------------------------
 
-.. lv_example:: styles/lv_example_style_14
+.. lv_example:: lv_example_style_14
   :language: c
 
 Opacity and Transformations
 ---------------------------
 
-.. lv_example:: styles/lv_example_style_15
+.. lv_example:: lv_example_style_15
   :language: c
 
 Metallic knob with conic gradient
 ---------------------------------
 
-.. lv_example:: styles/lv_example_style_16
+.. lv_example:: lv_example_style_16
   :language: c
 
 Radial gradient as background
 -----------------------------
 
-.. lv_example:: styles/lv_example_style_17
+.. lv_example:: lv_example_style_17
   :language: c
 
 Gradients for button background
 -------------------------------
 
-.. lv_example:: styles/lv_example_style_18
+.. lv_example:: lv_example_style_18
   :language: c
 
 Test between recolor style or full background modal
 ---------------------------------------------------
 
-.. lv_example:: styles/lv_example_style_19
+.. lv_example:: lv_example_style_19
   :language: c
 
 
 Transform style
 ---------------
 
-.. lv_example:: styles/lv_example_style_20
+.. lv_example:: lv_example_style_20
   :language: c

examples/widgets/animimg/index.rst

@@ -1,7 +1,10 @@
+Animation Image
+***************
+
 
 Simple Animation Image
 ----------------------
 
-.. lv_example:: widgets/animimg/lv_example_animimg_1
+.. lv_example:: lv_example_animimg_1
   :language: c
   :description: A simple example to demonstrate the use of an animation image.

examples/widgets/arc/index.rst

@@ -2,18 +2,18 @@
 Simple Arc
 ----------
 
-.. lv_example:: widgets/arc/lv_example_arc_1
+.. lv_example:: lv_example_arc_1
   :language: c
   :description: A simple example to demonstrate the use of an arc.
 
 Loader with Arc
 ---------------
 
-.. lv_example:: widgets/arc/lv_example_arc_2
+.. lv_example:: lv_example_arc_2
   :language: c
 
 Pie Chart with clickable slices using Arcs
 ------------------------------------------
 
-.. lv_example:: widgets/arc/lv_example_arc_3
+.. lv_example:: lv_example_arc_3
   :language: c

examples/widgets/arclabel/index.rst

@@ -1,6 +1,10 @@
+Arc Label
+*********
+
+
 Simple Arc Label
 ----------------
 
-.. lv_example:: widgets/arclabel/lv_example_arclabel_1
+.. lv_example:: lv_example_arclabel_1
     :language: c
     :description: A simple example to demonstrate the use of an arc label.

examples/widgets/bar/index.rst

@@ -1,42 +1,42 @@
 Simple Bar
 ----------
 
-.. lv_example:: widgets/bar/lv_example_bar_1
+.. lv_example:: lv_example_bar_1
   :language: c
 
 Styling a bar
 -------------
 
-.. lv_example:: widgets/bar/lv_example_bar_2
+.. lv_example:: lv_example_bar_2
   :language: c
 
 Temperature meter
 -----------------
 
-.. lv_example:: widgets/bar/lv_example_bar_3
+.. lv_example:: lv_example_bar_3
   :language: c
 
 Stripe pattern and range value
 ------------------------------
 
-.. lv_example:: widgets/bar/lv_example_bar_4
+.. lv_example:: lv_example_bar_4
   :language: c
 
 Bar with LTR and RTL base direction
 -----------------------------------
 
-.. lv_example:: widgets/bar/lv_example_bar_5
+.. lv_example:: lv_example_bar_5
   :language: c
 
 Custom drawer to show the current value
 ---------------------------------------
 
-.. lv_example:: widgets/bar/lv_example_bar_6
+.. lv_example:: lv_example_bar_6
   :language: c
 
 Bar with opposite direction
 ---------------------------
 
-.. lv_example:: widgets/bar/lv_example_bar_7
+.. lv_example:: lv_example_bar_7
   :language: c
 

examples/widgets/button/index.rst

@@ -2,19 +2,19 @@
 Simple Buttons
 --------------
 
-.. lv_example:: widgets/button/lv_example_button_1
+.. lv_example:: lv_example_button_1
   :language: c
 
 
 Styling buttons
 ---------------
 
-.. lv_example:: widgets/button/lv_example_button_2
+.. lv_example:: lv_example_button_2
   :language: c
 
 Gummy button
 ------------
 
-.. lv_example:: widgets/button/lv_example_button_3
+.. lv_example:: lv_example_button_3
   :language: c
 

examples/widgets/buttonmatrix/index.rst

@@ -1,22 +1,25 @@
+Button Matrix
+*************
+
 
 Simple Button matrix
 --------------------
 
-.. lv_example:: widgets/buttonmatrix/lv_example_buttonmatrix_1
+.. lv_example:: lv_example_buttonmatrix_1
   :language: c
 
 
 Custom buttons
 --------------
 
-.. lv_example:: widgets/buttonmatrix/lv_example_buttonmatrix_2
+.. lv_example:: lv_example_buttonmatrix_2
   :language: c
 
 
 Pagination
 ----------
 
-.. lv_example:: widgets/buttonmatrix/lv_example_buttonmatrix_3
+.. lv_example:: lv_example_buttonmatrix_3
   :language: c
 
 

examples/widgets/calendar/index.rst

@@ -2,11 +2,11 @@
 Calendar with header
 --------------------
 
-.. lv_example:: widgets/calendar/lv_example_calendar_1
+.. lv_example:: lv_example_calendar_1
   :language: c
 
 Chinese calendar
 -------------------------------------
 
-.. lv_example:: widgets/calendar/lv_example_calendar_2
+.. lv_example:: lv_example_calendar_2
   :language: c

examples/widgets/canvas/index.rst

@@ -1,78 +1,78 @@
 Drawing on the Canvas and rotate
 --------------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_1
+.. lv_example:: lv_example_canvas_1
   :language: c
 
 Transparent Canvas with chroma keying
 -------------------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_2
+.. lv_example:: lv_example_canvas_2
   :language: c
 
 
 Draw a rectangle to the canvas
 ------------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_3
+.. lv_example:: lv_example_canvas_3
   :language: c
 
 
 Draw a label to the canvas
 --------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_4
+.. lv_example:: lv_example_canvas_4
   :language: c
 
 
 Draw an arc to the canvas
 -------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_5
+.. lv_example:: lv_example_canvas_5
   :language: c
 
 
 Draw an image to the canvas
 ---------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_6
+.. lv_example:: lv_example_canvas_6
   :language: c
 
 
 Draw a line to the canvas
 -------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_7
+.. lv_example:: lv_example_canvas_7
   :language: c
 
 Draw a vector graphic to the canvas
 -----------------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_8
+.. lv_example:: lv_example_canvas_8
   :language: c
 
 Draw a triangle to the canvas
 -----------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_9
+.. lv_example:: lv_example_canvas_9
   :language: c
 
 Blur an area on the canvas
 -----------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_10
+.. lv_example:: lv_example_canvas_10
   :language: c
 
 
 Draw Fancy Letter Effects
 -------------------------
 
-.. lv_example:: widgets/canvas/lv_example_canvas_11
+.. lv_example:: lv_example_canvas_11
   :language: c
 
 
 Draw Fancy Letter Effects 2
 ---------------------------
-.. lv_example:: widgets/canvas/lv_example_canvas_12
+.. lv_example:: lv_example_canvas_12
   :language: c