Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): fix broken links in ./lvgl/README.md #7146

Merged
merged 4 commits into from
Oct 28, 2024

Conversation

vwheeler63
Copy link
Contributor

Fixes links in ./lvgl/README.md that were broken from PR #7136.

cc: @kisvegabor

Notes

  • Update the Documentation if needed. Done.
  • Add Examples if relevant. n/a
  • Add Tests if applicable. n/a
  • If you added new options to lv_conf_template.h run lv_conf_internal_gen.py and update Kconfig. n/a
  • Run scripts/code-format.py (astyle v3.4.12 needs to installed by running cd scripts; ./install_astyle.sh) and follow the Code Conventions. n/a
  • Mark the Pull request as Draft while you are working on the first version, and mark is as Ready when it's ready for review. Done.
  • When changes were requested, re-request review to notify the maintainers. Done.
  • Help us to review this Pull Request! Anyone can approve or request changes.

@kisvegabor
Copy link
Member

Can we fix it with Sphinx redirect so that the old links will work too?

@vwheeler63
Copy link
Contributor Author

Can we fix it with Sphinx redirect so that the old links will work too?

I'm on it.

@vwheeler63
Copy link
Contributor Author

Hi, Gábor! ( @kisvegabor )

I am ready with the links that were in ./lvgl/README.md. I also realized we changed 2 paths after I had made modifications to the translated READMEs as well, plus I realized that these do not go through Sphinx, so I re-translated the 2 :ref: links I put in them back to fully-spelled-out URLs.

I added just that subset of changes into the redirects dictionary in conf.py.

And it is making me wonder if I need to make a file-rename map, since my need to remember where things went has come up many times now....

@vwheeler63
Copy link
Contributor Author

vwheeler63 commented Oct 25, 2024

Hi, Gábor! ( @kisvegabor )

Because thinking through where documents moved has now come across my plate so many times (including the modifications to conf.py herein), I made a map of where the files went. I was thinking of adding it to the ./docs/ directory, but in reality, it will only be needed for a little while during any adjustments. (I have an editor that made this easy.) I suspect quite a few people will want to refer to this, but wanted to pass it by you to get your thoughts on it (i.e. who would need it and how it should be presented). Now that I have it, I can easily change its format to something more suitable.

Kind regards,
Vic

Doc-File Disposition Map
========================

+------------------------------------------------+------------------------------------------------------------------+
| Previous File Relative to ./docs/              | New File Relative to ./docs/                                     |
| ===============================================+==================================================================+
|                                                |                                                                  |
|                                                |                                                                  |
| New Files:                                     |                                                                  |
| ----------                                     |                                                                  |
|                                                | details/base-widget/index.rst                                    |
|                                                | details/base-widget/styles/index.rst                             |
|                                                | details/index.rst                                                |
|                                                | intro/add-lvgl-to-your-project/building_lvgl.rst                 |
|                                                | intro/add-lvgl-to-your-project/configuration.rst                 |
|                                                | intro/add-lvgl-to-your-project/getting_lvgl.rst                  |
|                                                | intro/add-lvgl-to-your-project/other_platforms.rst               |
|                                                | intro/index.rst                                                  |
|                                                |                                                                  |
|                                                |                                                                  |
| Files that Stayed in Same Location:            |                                                                  |
| -----------------------------------            |                                                                  |
| CHANGELOG.rst                                  | CHANGELOG.rst                                                    |
| CODING_STYLE.rst                               | CODING_STYLE.rst                                                 |
| CONTRIBUTING.rst                               | CONTRIBUTING.rst                                                 |
| index.rst                                      | index.rst                                                        |
| README_jp.rst                                  | README_jp.rst                                                    |
| README_pt_BR.rst                               | README_pt_BR.rst                                                 |
| README_zh.rst                                  | README_zh.rst                                                    |
| ROADMAP.rst                                    | ROADMAP.rst                                                      |
|                                                |                                                                  |
|                                                |                                                                  |
| Files Removed:                                 |                                                                  |
| --------------                                 |                                                                  |
| get-started/index.rst                          | combined into intro/basics.rst
| overview/obj.rst                               | combined into details/base-widget/obj.rst                        |
| porting/display.rst                            | combined into details/main-components/display.rst                |
| porting/indev.rst                              | combined into details/main-components/indev.rst                  |
| porting/sleep.rst                              | combined into intro/add-lvgl-to-your-project/threading.rst       |
| porting/tick.rst                               | combined into intro/add-lvgl-to-your-project/connecting_lvgl.rst |
|                                                |                                                                  |
|                                                |                                                                  |
| Files Renamed:                                 |                                                                  |
| --------------                                 |                                                                  |
| get-started/quick-overview.rst                 | intro/basics.rst                                                 |
| intro/index.rst                                | intro/introduction.rst                                           |
| overview/renderers/pxp.rst                     | details/integration/renderers/nxp_pxp.rst                        |
| overview/renderers/vglite.rst                  | details/integration/renderers/nxp_vglite_gpu.rst                 |
| overview/style-props.rst                       | details/base-widget/styles/style-properties.rst                  |
| porting/os.rst                                 | intro/add-lvgl-to-your-project/threading.rst                     |
| porting/project.rst                            | intro/add-lvgl-to-your-project/connecting_lvgl.rst               |
|                                                |                                                                  |
|                                                |                                                                  |
| Files Moved:                                   |                                                                  |
| ------------                                   |                                                                  |
| integration/bindings/api_json.rst              | details/integration/bindings/api_json.rst                        |
| integration/bindings/cpp.rst                   | details/integration/bindings/cpp.rst                             |
| integration/bindings/index.rst                 | details/integration/bindings/index.rst                           |
| integration/bindings/javascript.rst            | details/integration/bindings/javascript.rst                      |
| integration/bindings/micropython.rst           | details/integration/bindings/micropython.rst                     |
| integration/bindings/pikascript.rst            | details/integration/bindings/pikascript.rst                      |
| integration/building/cmake.rst                 | details/integration/building/cmake.rst                           |
| integration/building/index.rst                 | details/integration/building/index.rst                           |
| integration/building/make.rst                  | details/integration/building/make.rst                            |
| integration/chip/arm.rst                       | details/integration/chip/arm.rst                                 |
| integration/chip/espressif.rst                 | details/integration/chip/espressif.rst                           |
| integration/chip/index.rst                     | details/integration/chip/index.rst                               |
| integration/chip/nxp.rst                       | details/integration/chip/nxp.rst                                 |
| integration/chip/renesas.rst                   | details/integration/chip/renesas.rst                             |
| integration/chip/stm32.rst                     | details/integration/chip/stm32.rst                               |
| integration/driver/display/fbdev.rst           | details/integration/driver/display/fbdev.rst                     |
| integration/driver/display/gen_mipi.rst        | details/integration/driver/display/gen_mipi.rst                  |
| integration/driver/display/ili9341.rst         | details/integration/driver/display/ili9341.rst                   |
| integration/driver/display/index.rst           | details/integration/driver/display/index.rst                     |
| integration/driver/display/lcd_stm32_guide.rst | details/integration/driver/display/lcd_stm32_guide.rst           |
| integration/driver/display/renesas_glcdc.rst   | details/integration/driver/display/renesas_glcdc.rst             |
| integration/driver/display/st7735.rst          | details/integration/driver/display/st7735.rst                    |
| integration/driver/display/st7789.rst          | details/integration/driver/display/st7789.rst                    |
| integration/driver/display/st7796.rst          | details/integration/driver/display/st7796.rst                    |
| integration/driver/display/st_ltdc.rst         | details/integration/driver/display/st_ltdc.rst                   |
| integration/driver/index.rst                   | details/integration/driver/index.rst                             |
| integration/driver/libinput.rst                | details/integration/driver/libinput.rst                          |
| integration/driver/opengles.rst                | details/integration/driver/opengles.rst                          |
| integration/driver/touchpad/evdev.rst          | details/integration/driver/touchpad/evdev.rst                    |
| integration/driver/touchpad/ft6x36.rst         | details/integration/driver/touchpad/ft6x36.rst                   |
| integration/driver/touchpad/index.rst          | details/integration/driver/touchpad/index.rst                    |
| integration/driver/wayland.rst                 | details/integration/driver/wayland.rst                           |
| integration/driver/windows.rst                 | details/integration/driver/windows.rst                           |
| integration/driver/X11.rst                     | details/integration/driver/X11.rst                               |
| integration/framework/arduino.rst              | details/integration/framework/arduino.rst                        |
| integration/framework/index.rst                | details/integration/framework/index.rst                          |
| integration/framework/platformio.rst           | details/integration/framework/platformio.rst                     |
| integration/framework/tasmota-berry.rst        | details/integration/framework/tasmota-berry.rst                  |
| integration/ide/index.rst                      | details/integration/ide/index.rst                                |
| integration/ide/mdk.rst                        | details/integration/ide/mdk.rst                                  |
| integration/ide/pc-simulator.rst               | details/integration/ide/pc-simulator.rst                         |
| integration/index.rst                          | details/integration/index.rst                                    |
| integration/os/freertos.rst                    | details/integration/os/freertos.rst                              |
| integration/os/index.rst                       | details/integration/os/index.rst                                 |
| integration/os/mqx.rst                         | details/integration/os/mqx.rst                                   |
| integration/os/nuttx.rst                       | details/integration/os/nuttx.rst                                 |
| integration/os/px5.rst                         | details/integration/os/px5.rst                                   |
| integration/os/qnx.rst                         | details/integration/os/qnx.rst                                   |
| integration/os/rt-thread.rst                   | details/integration/os/rt-thread.rst                             |
| integration/os/yocto/core_components.rst       | details/integration/os/yocto/core_components.rst                 |
| integration/os/yocto/index.rst                 | details/integration/os/yocto/index.rst                           |
| integration/os/yocto/lvgl_recipe.rst           | details/integration/os/yocto/lvgl_recipe.rst                     |
| integration/os/yocto/terms_and_variables.rst   | details/integration/os/yocto/terms_and_variables.rst             |
| integration/os/zephyr.rst                      | details/integration/os/zephyr.rst                                |
| layouts/flex.rst                               | details/base-widget/layouts/flex.rst                             |
| layouts/grid.rst                               | details/base-widget/layouts/grid.rst                             |
| layouts/index.rst                              | details/base-widget/layouts/index.rst                            |
| libs/arduino_esp_littlefs.rst                  | details/libs/arduino_esp_littlefs.rst                            |
| libs/arduino_sd.rst                            | details/libs/arduino_sd.rst                                      |
| libs/barcode.rst                               | details/libs/barcode.rst                                         |
| libs/bmp.rst                                   | details/libs/bmp.rst                                             |
| libs/ffmpeg.rst                                | details/libs/ffmpeg.rst                                          |
| libs/freetype.rst                              | details/libs/freetype.rst                                        |
| libs/fs.rst                                    | details/libs/fs.rst                                              |
| libs/gif.rst                                   | details/libs/gif.rst                                             |
| libs/index.rst                                 | details/libs/index.rst                                           |
| libs/lfs.rst                                   | details/libs/lfs.rst                                             |
| libs/libjpeg_turbo.rst                         | details/libs/libjpeg_turbo.rst                                   |
| libs/libpng.rst                                | details/libs/libpng.rst                                          |
| libs/lodepng.rst                               | details/libs/lodepng.rst                                         |
| libs/qrcode.rst                                | details/libs/qrcode.rst                                          |
| libs/rle.rst                                   | details/libs/rle.rst                                             |
| libs/rlottie.rst                               | details/libs/rlottie.rst                                         |
| libs/svg.rst                                   | details/libs/svg.rst                                             |
| libs/tiny_ttf.rst                              | details/libs/tiny_ttf.rst                                        |
| libs/tjpgd.rst                                 | details/libs/tjpgd.rst                                           |
| others/file_explorer.rst                       | details/other-components/file_explorer.rst                       |
| others/font_manager.rst                        | details/other-components/font_manager.rst                        |
| others/fragment.rst                            | details/other-components/fragment.rst                            |
| others/gridnav.rst                             | details/other-components/gridnav.rst                             |
| others/ime_pinyin.rst                          | details/other-components/ime_pinyin.rst                          |
| others/imgfont.rst                             | details/other-components/imgfont.rst                             |
| others/index.rst                               | details/other-components/index.rst                               |
| others/monkey.rst                              | details/other-components/monkey.rst                              |
| others/obj_id.rst                              | details/other-components/obj_id.rst                              |
| others/obj_property.rst                        | details/other-components/obj_property.rst                        |
| others/observer.rst                            | details/other-components/observer.rst                            |
| others/snapshot.rst                            | details/other-components/snapshot.rst                            |
| overview/animations.rst                        | details/main-components/animation.rst                            |
| overview/color.rst                             | details/main-components/color.rst                                |
| overview/coord.rst                             | details/base-widget/coord.rst                                    |
| overview/debugging/gdb_plugin.rst              | details/debugging/gdb_plugin.rst                                 |
| overview/debugging/index.rst                   | details/debugging/index.rst                                      |
| overview/debugging/log.rst                     | details/debugging/log.rst                                        |
| overview/debugging/profiler.rst                | details/debugging/profiler.rst                                   |
| overview/debugging/vg_lite_tvg.rst             | details/debugging/vg_lite_tvg.rst                                |
| overview/display.rst                           | details/main-components/display.rst                              |
| overview/event.rst                             | details/base-widget/event.rst                                    |
| overview/font.rst                              | details/main-components/font.rst                                 |
| overview/fs.rst                                | details/main-components/fs.rst                                   |
| overview/image.rst                             | details/main-components/image.rst                                |
| overview/indev.rst                             | details/main-components/indev.rst                                |
| overview/index.rst                             | details/main-components/index.rst                                |
| overview/layer.rst                             | details/base-widget/layer.rst                                    |
| overview/new_widget.rst                        | details/widgets/new_widget.rst                                   |
| overview/renderers/arm2d.rst                   | details/integration/renderers/arm2d.rst                          |
| overview/renderers/index.rst                   | details/integration/renderers/index.rst                          |
| overview/renderers/nema_gfx.rst                | details/integration/renderers/nema_gfx.rst                       |
| overview/renderers/sdl.rst                     | details/integration/renderers/sdl.rst                            |
| overview/renderers/stm32_dma2d.rst             | details/integration/renderers/stm32_dma2d.rst                    |
| overview/renderers/sw.rst                      | details/integration/renderers/sw.rst                             |
| overview/renderers/vg_lite.rst                 | details/integration/renderers/vg_lite.rst                        |
| overview/scroll.rst                            | details/base-widget/scroll.rst                                   |
| overview/style.rst                             | details/base-widget/styles/style.rst                             |
| overview/timer.rst                             | details/main-components/timer.rst                                |
| porting/draw.rst                               | details/main-components/draw.rst                                 |
| porting/index.rst                              | intro/add-lvgl-to-your-project/index.rst                         |
| porting/timer_handler.rst                      | intro/add-lvgl-to-your-project/timer_handler.rst                 |
| widgets/animimg.rst                            | details/widgets/animimg.rst                                      |
| widgets/arc.rst                                | details/widgets/arc.rst                                          |
| widgets/bar.rst                                | details/widgets/bar.rst                                          |
| widgets/button.rst                             | details/widgets/button.rst                                       |
| widgets/buttonmatrix.rst                       | details/widgets/buttonmatrix.rst                                 |
| widgets/calendar.rst                           | details/widgets/calendar.rst                                     |
| widgets/canvas.rst                             | details/widgets/canvas.rst                                       |
| widgets/chart.rst                              | details/widgets/chart.rst                                        |
| widgets/checkbox.rst                           | details/widgets/checkbox.rst                                     |
| widgets/dropdown.rst                           | details/widgets/dropdown.rst                                     |
| widgets/image.rst                              | details/widgets/image.rst                                        |
| widgets/imagebutton.rst                        | details/widgets/imagebutton.rst                                  |
| widgets/index.rst                              | details/widgets/index.rst                                        |
| widgets/keyboard.rst                           | details/widgets/keyboard.rst                                     |
| widgets/label.rst                              | details/widgets/label.rst                                        |
| widgets/led.rst                                | details/widgets/led.rst                                          |
| widgets/line.rst                               | details/widgets/line.rst                                         |
| widgets/list.rst                               | details/widgets/list.rst                                         |
| widgets/lottie.rst                             | details/widgets/lottie.rst                                       |
| widgets/menu.rst                               | details/widgets/menu.rst                                         |
| widgets/msgbox.rst                             | details/widgets/msgbox.rst                                       |
| widgets/obj.rst                                | details/base-widget/obj.rst                                      |
| widgets/roller.rst                             | details/widgets/roller.rst                                       |
| widgets/scale.rst                              | details/widgets/scale.rst                                        |
| widgets/slider.rst                             | details/widgets/slider.rst                                       |
| widgets/span.rst                               | details/widgets/span.rst                                         |
| widgets/spinbox.rst                            | details/widgets/spinbox.rst                                      |
| widgets/spinner.rst                            | details/widgets/spinner.rst                                      |
| widgets/switch.rst                             | details/widgets/switch.rst                                       |
| widgets/table.rst                              | details/widgets/table.rst                                        |
| widgets/tabview.rst                            | details/widgets/tabview.rst                                      |
| widgets/textarea.rst                           | details/widgets/textarea.rst                                     |
| widgets/tileview.rst                           | details/widgets/tileview.rst                                     |
| widgets/win.rst                                | details/widgets/win.rst                                          |
+------------------------------------------------+------------------------------------------------------------------+

@vwheeler63
Copy link
Contributor Author

vwheeler63 commented Oct 25, 2024

@kisvegabor

Also, now that I have this in list form, in theory, all of the MOVED files could be put into the redirects dictionary. That would be 165 .html files generated -- all representing files in the old website that have new URLs now, redirecting to the new pages.

This seems a bit far, but it is doable, and would not take long. And it would ELIMINATE 404 errors no matter where in the field they were stored. Let me know.

Kind regards,
Vic

P.S. This is what it would look like:

redirects = {
    "get-started/index":                          "../intro/basics.html"                                            ,
    "get-started/quick-overview":                 "../intro/basics.html"                                            ,
    "integration/bindings/api_json":              "../../details/integration/bindings/api_json.html"                ,
    "integration/bindings/cpp":                   "../../details/integration/bindings/cpp.html"                     ,
    "integration/bindings/index":                 "../../details/integration/bindings/index.html"                   ,
    "integration/bindings/javascript":            "../../details/integration/bindings/javascript.html"              ,
    "integration/bindings/micropython":           "../../details/integration/bindings/micropython.html"             ,
    "integration/bindings/pikascript":            "../../details/integration/bindings/pikascript.html"              ,
    "integration/building/cmake":                 "../../details/integration/building/cmake.html"                   ,
    "integration/building/index":                 "../../details/integration/building/index.html"                   ,
    "integration/building/make":                  "../../details/integration/building/make.html"                    ,
    "integration/chip/arm":                       "../../details/integration/chip/arm.html"                         ,
    "integration/chip/espressif":                 "../../details/integration/chip/espressif.html"                   ,
    "integration/chip/index":                     "../../details/integration/chip/index.html"                       ,
    "integration/chip/nxp":                       "../../details/integration/chip/nxp.html"                         ,
    "integration/chip/renesas":                   "../../details/integration/chip/renesas.html"                     ,
    "integration/chip/stm32":                     "../../details/integration/chip/stm32.html"                       ,
    "integration/driver/X11":                     "../../details/integration/driver/X11.html"                       ,
    "integration/driver/display/fbdev":           "../../../details/integration/driver/display/fbdev.html"          ,
    "integration/driver/display/gen_mipi":        "../../../details/integration/driver/display/gen_mipi.html"       ,
    "integration/driver/display/ili9341":         "../../../details/integration/driver/display/ili9341.html"        ,
    "integration/driver/display/index":           "../../../details/integration/driver/display/index.html"          ,
    "integration/driver/display/lcd_stm32_guide": "../../../details/integration/driver/display/lcd_stm32_guide.html",
    "integration/driver/display/renesas_glcdc":   "../../../details/integration/driver/display/renesas_glcdc.html"  ,
    "integration/driver/display/st7735":          "../../../details/integration/driver/display/st7735.html"         ,
    "integration/driver/display/st7789":          "../../../details/integration/driver/display/st7789.html"         ,
    "integration/driver/display/st7796":          "../../../details/integration/driver/display/st7796.html"         ,
    "integration/driver/display/st_ltdc":         "../../../details/integration/driver/display/st_ltdc.html"        ,
    "integration/driver/index":                   "../../details/integration/driver/index.html"                     ,
    "integration/driver/libinput":                "../../details/integration/driver/libinput.html"                  ,
    "integration/driver/opengles":                "../../details/integration/driver/opengles.html"                  ,
    "integration/driver/touchpad/evdev":          "../../../details/integration/driver/touchpad/evdev.html"         ,
    "integration/driver/touchpad/ft6x36":         "../../../details/integration/driver/touchpad/ft6x36.html"        ,
    "integration/driver/touchpad/index":          "../../../details/integration/driver/touchpad/index.html"         ,
    "integration/driver/wayland":                 "../../details/integration/driver/wayland.html"                   ,
    "integration/driver/windows":                 "../../details/integration/driver/windows.html"                   ,
    "integration/framework/arduino":              "../../details/integration/framework/arduino.html"                ,
    "integration/framework/index":                "../../details/integration/framework/index.html"                  ,
    "integration/framework/platformio":           "../../details/integration/framework/platformio.html"             ,
    "integration/framework/tasmota-berry":        "../../details/integration/framework/tasmota-berry.html"          ,
    "integration/ide/index":                      "../../details/integration/ide/index.html"                        ,
    "integration/ide/mdk":                        "../../details/integration/ide/mdk.html"                          ,
    "integration/ide/pc-simulator":               "../../details/integration/ide/pc-simulator.html"                 ,
    "integration/index":                          "../details/integration/index.html"                               ,
    "integration/os/freertos":                    "../../details/integration/os/freertos.html"                      ,
    "integration/os/index":                       "../../details/integration/os/index.html"                         ,
    "integration/os/mqx":                         "../../details/integration/os/mqx.html"                           ,
    "integration/os/nuttx":                       "../../details/integration/os/nuttx.html"                         ,
    "integration/os/px5":                         "../../details/integration/os/px5.html"                           ,
    "integration/os/qnx":                         "../../details/integration/os/qnx.html"                           ,
    "integration/os/rt-thread":                   "../../details/integration/os/rt-thread.html"                     ,
    "integration/os/yocto/core_components":       "../../../details/integration/os/yocto/core_components.html"      ,
    "integration/os/yocto/index":                 "../../../details/integration/os/yocto/index.html"                ,
    "integration/os/yocto/lvgl_recipe":           "../../../details/integration/os/yocto/lvgl_recipe.html"          ,
    "integration/os/yocto/terms_and_variables":   "../../../details/integration/os/yocto/terms_and_variables.html"  ,
    "integration/os/zephyr":                      "../../details/integration/os/zephyr.html"                        ,
    "intro/index":                                "../intro/introduction.html"                                      ,
    "layouts/flex":                               "../details/base-widget/layouts/flex.html"                        ,
    "layouts/grid":                               "../details/base-widget/layouts/grid.html"                        ,
    "layouts/index":                              "../details/base-widget/layouts/index.html"                       ,
    "libs/arduino_esp_littlefs":                  "../details/libs/arduino_esp_littlefs.html"                       ,
    "libs/arduino_sd":                            "../details/libs/arduino_sd.html"                                 ,
    "libs/barcode":                               "../details/libs/barcode.html"                                    ,
    "libs/bmp":                                   "../details/libs/bmp.html"                                        ,
    "libs/ffmpeg":                                "../details/libs/ffmpeg.html"                                     ,
    "libs/freetype":                              "../details/libs/freetype.html"                                   ,
    "libs/fs":                                    "../details/libs/fs.html"                                         ,
    "libs/gif":                                   "../details/libs/gif.html"                                        ,
    "libs/index":                                 "../details/libs/index.html"                                      ,
    "libs/lfs":                                   "../details/libs/lfs.html"                                        ,
    "libs/libjpeg_turbo":                         "../details/libs/libjpeg_turbo.html"                              ,
    "libs/libpng":                                "../details/libs/libpng.html"                                     ,
    "libs/lodepng":                               "../details/libs/lodepng.html"                                    ,
    "libs/qrcode":                                "../details/libs/qrcode.html"                                     ,
    "libs/rle":                                   "../details/libs/rle.html"                                        ,
    "libs/rlottie":                               "../details/libs/rlottie.html"                                    ,
    "libs/svg":                                   "../details/libs/svg.html"                                        ,
    "libs/tiny_ttf":                              "../details/libs/tiny_ttf.html"                                   ,
    "libs/tjpgd":                                 "../details/libs/tjpgd.html"                                      ,
    "others/file_explorer":                       "../details/other-components/file_explorer.html"                  ,
    "others/font_manager":                        "../details/other-components/font_manager.html"                   ,
    "others/fragment":                            "../details/other-components/fragment.html"                       ,
    "others/gridnav":                             "../details/other-components/gridnav.html"                        ,
    "others/ime_pinyin":                          "../details/other-components/ime_pinyin.html"                     ,
    "others/imgfont":                             "../details/other-components/imgfont.html"                        ,
    "others/index":                               "../details/other-components/index.html"                          ,
    "others/monkey":                              "../details/other-components/monkey.html"                         ,
    "others/obj_id":                              "../details/other-components/obj_id.html"                         ,
    "others/obj_property":                        "../details/other-components/obj_property.html"                   ,
    "others/observer":                            "../details/other-components/observer.html"                       ,
    "others/snapshot":                            "../details/other-components/snapshot.html"                       ,
    "overview/animations":                        "../details/main-components/animation.html"                       ,
    "overview/color":                             "../details/main-components/color.html"                           ,
    "overview/coord":                             "../details/base-widget/coord.html"                               ,
    "overview/debugging/gdb_plugin":              "../../details/debugging/gdb_plugin.html"                         ,
    "overview/debugging/index":                   "../../details/debugging/index.html"                              ,
    "overview/debugging/log":                     "../../details/debugging/log.html"                                ,
    "overview/debugging/profiler":                "../../details/debugging/profiler.html"                           ,
    "overview/debugging/vg_lite_tvg":             "../../details/debugging/vg_lite_tvg.html"                        ,
    "overview/display":                           "../details/main-components/display.html"                         ,
    "overview/event":                             "../details/base-widget/event.html"                               ,
    "overview/font":                              "../details/main-components/font.html"                            ,
    "overview/fs":                                "../details/main-components/fs.html"                              ,
    "overview/image":                             "../details/main-components/image.html"                           ,
    "overview/indev":                             "../details/main-components/indev.html"                           ,
    "overview/index":                             "../details/main-components/index.html"                           ,
    "overview/layer":                             "../details/base-widget/layer.html"                               ,
    "overview/new_widget":                        "../details/widgets/new_widget.html"                              ,
    "overview/obj":                               "../details/base-widget/obj.html"                                 ,
    "overview/renderers/arm2d":                   "../../details/integration/renderers/arm2d.html"                  ,
    "overview/renderers/index":                   "../../details/integration/renderers/index.html"                  ,
    "overview/renderers/nema_gfx":                "../../details/integration/renderers/nema_gfx.html"               ,
    "overview/renderers/pxp":                     "../../details/integration/renderers/nxp_pxp.html"                ,
    "overview/renderers/sdl":                     "../../details/integration/renderers/sdl.html"                    ,
    "overview/renderers/stm32_dma2d":             "../../details/integration/renderers/stm32_dma2d.html"            ,
    "overview/renderers/sw":                      "../../details/integration/renderers/sw.html"                     ,
    "overview/renderers/vg_lite":                 "../../details/integration/renderers/vg_lite.html"                ,
    "overview/renderers/vglite":                  "../../details/integration/renderers/nxp_vglite_gpu.html"         ,
    "overview/scroll":                            "../details/base-widget/scroll.html"                              ,
    "overview/style":                             "../details/base-widget/styles/style.html"                        ,
    "overview/style-props":                       "../details/base-widget/styles/style-properties.html"             ,
    "overview/timer":                             "../details/main-components/timer.html"                           ,
    "porting/display":                            "../details/main-components/display.html"                         ,
    "porting/draw":                               "../details/main-components/draw.html"                            ,
    "porting/indev":                              "../details/main-components/indev.html"                           ,
    "porting/index":                              "../intro/add-lvgl-to-your-project/index.html"                    ,
    "porting/os":                                 "../intro/add-lvgl-to-your-project/threading.html"                ,
    "porting/project":                            "../intro/add-lvgl-to-your-project/connecting_lvgl.html"          ,
    "porting/sleep":                              "../intro/add-lvgl-to-your-project/threading.html"                ,
    "porting/tick":                               "../intro/add-lvgl-to-your-project/connecting_lvgl.html"          ,
    "porting/timer_handler":                      "../intro/add-lvgl-to-your-project/timer_handler.html"            ,
    "widgets/animimg":                            "../details/widgets/animimg.html"                                 ,
    "widgets/arc":                                "../details/widgets/arc.html"                                     ,
    "widgets/bar":                                "../details/widgets/bar.html"                                     ,
    "widgets/button":                             "../details/widgets/button.html"                                  ,
    "widgets/buttonmatrix":                       "../details/widgets/buttonmatrix.html"                            ,
    "widgets/calendar":                           "../details/widgets/calendar.html"                                ,
    "widgets/canvas":                             "../details/widgets/canvas.html"                                  ,
    "widgets/chart":                              "../details/widgets/chart.html"                                   ,
    "widgets/checkbox":                           "../details/widgets/checkbox.html"                                ,
    "widgets/dropdown":                           "../details/widgets/dropdown.html"                                ,
    "widgets/image":                              "../details/widgets/image.html"                                   ,
    "widgets/imagebutton":                        "../details/widgets/imagebutton.html"                             ,
    "widgets/index":                              "../details/widgets/index.html"                                   ,
    "widgets/keyboard":                           "../details/widgets/keyboard.html"                                ,
    "widgets/label":                              "../details/widgets/label.html"                                   ,
    "widgets/led":                                "../details/widgets/led.html"                                     ,
    "widgets/line":                               "../details/widgets/line.html"                                    ,
    "widgets/list":                               "../details/widgets/list.html"                                    ,
    "widgets/lottie":                             "../details/widgets/lottie.html"                                  ,
    "widgets/menu":                               "../details/widgets/menu.html"                                    ,
    "widgets/msgbox":                             "../details/widgets/msgbox.html"                                  ,
    "widgets/obj":                                "../details/base-widget/obj.html"                                 ,
    "widgets/roller":                             "../details/widgets/roller.html"                                  ,
    "widgets/scale":                              "../details/widgets/scale.html"                                   ,
    "widgets/slider":                             "../details/widgets/slider.html"                                  ,
    "widgets/span":                               "../details/widgets/span.html"                                    ,
    "widgets/spinbox":                            "../details/widgets/spinbox.html"                                 ,
    "widgets/spinner":                            "../details/widgets/spinner.html"                                 ,
    "widgets/switch":                             "../details/widgets/switch.html"                                  ,
    "widgets/table":                              "../details/widgets/table.html"                                   ,
    "widgets/tabview":                            "../details/widgets/tabview.html"                                 ,
    "widgets/textarea":                           "../details/widgets/textarea.html"                                ,
    "widgets/tileview":                           "../details/widgets/tileview.html"                                ,
    "widgets/win":                                "../details/widgets/win.html"                                     ,
}

@kisvegabor
Copy link
Member

Wow, there are a lot links to fix. Can we make use of wildcards?

@vwheeler63
Copy link
Contributor Author

vwheeler63 commented Oct 25, 2024

Wow, there are a lot links to fix. Can we make use of wildcards?

I believe I saw some facilities for wildcards. However, given I have the list and a generated test, we don't need wildcards. It would just make it more complicated. You can see it on my demo website. I did a copy/paste of the above into conf.py. So you can now try any link that used to go to a docs page before and it will redirect to the appropriate HTML file. Example:

http://crystal-clear-research.com/for_gabor/demo/docs.lvgl.io/master/layouts/flex.html

Kind regards,
Vic

kisvegabor
kisvegabor previously approved these changes Oct 25, 2024
Copy link
Member

@kisvegabor kisvegabor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Vic!
I've tested a few links and they worked well! I'll announce the reorganized docs when when it's merged.

@vwheeler63
Copy link
Contributor Author

Thank you Vic! I've tested a few links and they worked well! I'll announce the reorganized docs when when it's merged.

Perfect!!

@vwheeler63
Copy link
Contributor Author

@kisvegabor P.S. Don't forget PR #7144. Reason: it adds a lot of documentation quality to styles, flex, and grid! They read so much better!

@vwheeler63
Copy link
Contributor Author

vwheeler63 commented Oct 25, 2024

@kisvegabor P.P.S. Sorry to invalidate your approval above, but I had not yet added in the rest of the redirects -- which WAS already showing and present in the "demo web site". The redirects that were previously present are unchanged, just more was added (what you tested on-line in the links above).

...fix a few broken links in translated README files.  (Full URLs
in the README's have to be spelled out because they do not
get translated by Sphinx.  So :ref: links won't work.

Also, 2 paths changed after the translated README's had changed:

- modules => main-components
- add-lvgl-to-your-project/project =>add-lvgl-to-your-project/connecting_lvgl
@vwheeler63 vwheeler63 force-pushed the fix/fix_readme_links branch from 517f95b to 422d950 Compare October 25, 2024 21:59
Copy link
Member

@kisvegabor kisvegabor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, thank you!

@FASTSHIFT FASTSHIFT merged commit 868db01 into lvgl:master Oct 28, 2024
21 checks passed
@vwheeler63
Copy link
Contributor Author

vwheeler63 commented Oct 28, 2024

Perfect, thank you!

By the way, the new redirects dictionary in conf.py is programmatically generated so I have no doubt it's 100%. With 165 redirects (actually 164 -- I removed 1 where there was already a legitimate index.html), I didn't want to leave any room for human error. And all URLs are relative. I hand-tested probably 30 of them and are 100%.

Thank you, @FASTSHIFT ! You merged this as I was typing this message!

Kind regards,
Vic

@vwheeler63 vwheeler63 deleted the fix/fix_readme_links branch October 28, 2024 10:41
rodb70 pushed a commit to rodb70/lvgl that referenced this pull request Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants