ci(docs) replace use of sed with proper configuration variables

docs/CONTRIBUTING.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/CONTRIBUTING.md
 ```
 
 # Contributing

docs/build.py

@@ -32,14 +32,8 @@ ex.exec()
 
 urlpath = re.sub('release/', '', br)
 
-# Be sure the GitHub links point to the right branch
-f = open("header.rst", "w")
-f.write(".. |github_link_base| replace:: https://github.com/lvgl/lvgl/blob/" + gitcommit + "/docs")
-f.close()
-
-base_html = "html_baseurl = 'https://docs.lvgl.io/" + urlpath + "/en/html/'"
-
-os.system("sed -i \"s|html_baseurl = .*|" + base_html +"|\" conf.py")
+os.environ['LVGL_URLPATH'] = urlpath
+os.environ['LVGL_GITCOMMIT'] = gitcommit
 
 clean = 0
 trans = 0

docs/conf.py

@@ -114,9 +114,23 @@ html_theme_options = {
     'logo_only': True,
 }
 # For site map generation
-html_baseurl = 'https://docs.lvgl.io/master/en/html/'
+html_baseurl = f"https://docs.lvgl.io/{os.environ['LVGL_URLPATH']}/en/html/"
+
 sitemap_url_scheme = "{link}"
 
+#lvgl_github_url = f"https://github.com/lvgl/lvgl/blob/{os.environ['LVGL_GITCOMMIT']}/docs"
+
+#extlinks = {'github_link_base': (github_url + '%s', github_url)}
+
+html_context = {
+    'github_version': os.environ['LVGL_GITCOMMIT'],
+    'github_user': 'lvgl',
+    'github_repo': 'lvgl',
+    'display_github': True,
+    'conf_py_path': '/docs/'
+}
+
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".

docs/example_list.py

@@ -103,7 +103,6 @@ def exec():
      d_all.update(d_act)
 
   fout.write("```eval_rst\n")
-  fout.write(".. include:: /header.rst\n")
   fout.write(":github_url: |github_link_base|/examples.md\n")
   fout.write("```\n")
   fout.write("\n")
@@ -124,4 +123,3 @@ def exec():
       print_item(h, 3, d_all, fout)
 
     fout.write("")
-

docs/get-started/bindings/cpp.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/bindings/micropython.md
 ```
 # Cpp
 

docs/get-started/bindings/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/bindings/index.md
 ```
 # Bindings
 

docs/get-started/bindings/micropython.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/bindings/micropython.md
 ```
 # Micropython
 

docs/get-started/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/index.md
 ```
 # Get started
 

docs/get-started/os/freertos.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/os/freertos.md
 ```
 # FreeRTOS
 

docs/get-started/os/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/os/index.md
 ```
 # (RT)OS
 

docs/get-started/os/nuttx.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/os/nuttx.md
 ```
 # NuttX RTOS
 

docs/get-started/os/rt-thread.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/os/rt-thread.md
 ```
 # RT-Thread RTOS
 

docs/get-started/os/zephyr.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/os/zephyr.md
 ```
 # Zephyr
 

docs/get-started/platforms/arduino.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/platforms/arduino.md
 ```
 
 # Arduino

docs/get-started/platforms/cmake.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/platforms/cmake.md
 ```
 
 # CMake

docs/get-started/platforms/espressif.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/platforms/espressif.md
 ```
 
 # Espressif (ESP32 chip series)

docs/get-started/platforms/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/index.md
 ```
 # Platforms
 

docs/get-started/platforms/nxp.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/platforms/nxp.md
 ```
 # NXP
 NXP has integrated LVGL into the MCUXpresso SDK packages for several of their general

docs/get-started/platforms/pc-simulator.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/platoforms/simulator.md
 ```
 # Simulator on PC
 

docs/get-started/platforms/stm32.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/platforms/stm32.md
 ```
 
 # STM32

docs/get-started/platforms/tasmota-berry.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/platforms/tasmota-berry.md
 ```
 # Tasmota and berry
 

docs/get-started/quick-overview.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/get-started/quick-overview.md
 ```
 
 # Quick overview

docs/header.rst

@@ -1 +0,0 @@
-.. |github_link_base| replace:: https://github.com/lvgl/lvgl/blob/8a8153219163b689e8f96d6a97c1f128eefd7ce2/docs

docs/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/index.md
 ```
 
 ```eval_rst

docs/intro/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/intro/index.md
 ```
 
 # Introduction

docs/layouts/flex.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/layouts/flex.md
 ```
 
 # Flex

docs/layouts/grid.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/layouts/grid.md
 ```
 
 # Grid

docs/layouts/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/layouts/index.md
 ```
 
 # Layouts

docs/libs/bmp.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/bmp.md
 ```
 
 # BMP decoder

docs/libs/ffmpeg.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/ffmpeg.md
 ```
 
 # FFmpeg support

docs/libs/freetype.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/freetype.md
 ```
 
 # FreeType support

docs/libs/fsdrv.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/fsdrv.md
 ```
 
 # File System Interfaces

docs/libs/gif.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/gif.md
 ```
 
 # GIF decoder

docs/libs/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/index.md
 ```
 # 3rd party libraries
 

docs/libs/png.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/png.md
 ```
 
 # PNG decoder

docs/libs/qrcode.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/qrcode.md
 ```
 
 # QR code

docs/libs/rlottie.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/rlottie.md
 ```
 
 

docs/libs/sjpg.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/libs/sjpg.md
 ```
 
 # JPG decoder

docs/others/fragment.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/others/fragment.md
 ```
 
 # Fragment

docs/others/gridnav.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/others/gridnav.md
 ```
 # Grid navigation
 

docs/others/imgfont.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/others/imgfont.md
 ```
 ## Image font (imgfont)
 Draw image in label or span obj with imgfont.

docs/others/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/others/index.md
 ```
 # Others
 

docs/others/monkey.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/others/monkey.md
 ```
 # Monkey
 

docs/others/msg.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/others/msg.md
 ```
 # Messaging
 

docs/others/snapshot.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/others/snapshot.md
 ```
 # Snapshot
 

docs/overview/animation.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/animation.md
 ```
 # Animations
 

docs/overview/color.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/color.md
 ```
 # Colors
 

docs/overview/coords.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/coords.md
 ```
 # Positions, sizes, and layouts
 

docs/overview/display.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/display.md
 ```
 # Displays
 

docs/overview/drawing.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/drawing.md
 ```
 # Drawing
 

docs/overview/event.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/event.md
 ```
 # Events
 

docs/overview/file-system.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/file-system.md
 ```
 # File system
 

docs/overview/font.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/font.md
 ```
 # Fonts
 

docs/overview/image.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/image.md
 ```
 # Images
 

docs/overview/indev.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/indev.md
 ```
 # Input devices
 

docs/overview/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/index.md
 ```
 
 # Overview

docs/overview/layer.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/layer.md
 ```
 
 # Layers

docs/overview/new_widget.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/new_widget.md
 ```
 
 # New widget

docs/overview/object.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/object.md
 ```
 # Objects
 

docs/overview/renderers/arm-2d.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/renderers/arm-2d.md
 ```
 # ARM-2D GPU
 

docs/overview/renderers/dma2d.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/renderers/dma2d.md
 ```
 # DMA2D GPU
 

docs/overview/renderers/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/renderers/index.md
 ```
 
 # Renderers and GPUs

docs/overview/renderers/pxp-vglite.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/renderers/pxp-vglite.md
 ```
 # NXP PXP and VGLite GPU
 

docs/overview/renderers/sdl.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/renderers/sdl.md
 ```
 # SDL renderer
 

docs/overview/renderers/sw.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/renderers/sw.md
 ```
 # Software renderer
 

docs/overview/scroll.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/scroll.md
 ```
 # Scroll
 

docs/overview/style.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/style.md
 ```
 # Styles
 

docs/overview/timer.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/overview/timer.md
 ```
 # Timers
 

docs/porting/display.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/display.md
 ```
 # Display interface
 

docs/porting/gpu.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/gpu.md
 ```
 # Add custom GPU
 LVGL has a flexible and extendable draw pipeline. You can hook it to do some rendering with a GPU or even completely replace the built-in software renderer.

docs/porting/indev.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/indev.md
 ```
 # Input device interface
 

docs/porting/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/index.md
 ```
 
 # Porting

docs/porting/log.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/log.md
 ```
 # Logging
 

docs/porting/os.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/os.md
 ```
 # Operating system and interrupts
 

docs/porting/project.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/project.md
 ```
 
 # Set up a project

docs/porting/sleep.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/sleep.md
 ```
 # Sleep management
 

docs/porting/tick.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/tick.md
 ```
 # Tick interface
 

docs/porting/timer-handler.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/porting/timer-handler.md
 ```
 # Timer Handler
 

docs/widgets/core/arc.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/arc.md
 ```
 # Arc (lv_arc)
 

docs/widgets/core/bar.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/bar.md
 ```
 # Bar (lv_bar)
 

docs/widgets/core/btn.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/btn.md
 ```
 # Button (lv_btn)
 

docs/widgets/core/btnmatrix.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/btnmatrix.md
 ```
 # Button matrix (lv_btnmatrix)
 

docs/widgets/core/canvas.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/canvas.md
 ```
 # Canvas (lv_canvas)
 

docs/widgets/core/checkbox.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/checkbox.md
 ```
 # Checkbox (lv_checkbox)
 

docs/widgets/core/dropdown.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/dropdown.md
 ```
 # Drop-down list (lv_dropdown)
 

docs/widgets/core/img.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/img.md
 ```
 # Image (lv_img)
 

docs/widgets/core/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/object-types/index.md
 ```
 # Core widgets
 

docs/widgets/core/label.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/core/label.md
 ```
 # Label (lv_label)
 

docs/widgets/core/line.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/line.md
 ```
 # Line (lv_line)
 

docs/widgets/core/roller.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/roller.md
 ```
 # Roller (lv_roller)
 

docs/widgets/core/slider.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/slider.md
 ```
 # Slider (lv_slider)
 

docs/widgets/core/switch.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/switch.md
 ```
 
 # Switch (lv_switch)

docs/widgets/core/table.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/table.md
 ```
 # Table (lv_table)
 

docs/widgets/core/textarea.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/core/textarea.md
 ```
 # Text area (lv_textarea)
 

docs/widgets/extra/animimg.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/extra/animimg.md
 ```
 # Animation Image (lv_animimg)
 

docs/widgets/extra/calendar.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/extra/calendar.md
 ```
 # Calendar (lv_calendar)
 

docs/widgets/extra/chart.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/extra/chart.md
 ```
 # Chart (lv_chart)
 

docs/widgets/extra/colorwheel.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/extra/colorwheel.md
 ```
 # Color wheel (lv_colorwheel)
 

docs/widgets/extra/imgbtn.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/widgets/extra/imgbtn.md
 ```
 # Image button (lv_imgbtn)
 

docs/widgets/extra/index.md

@@ -1,6 +1,4 @@
 ```eval_rst
-.. include:: /header.rst
-:github_url: |github_link_base|/object-types/index.md
 ```
 # Extra widgets