From f584a30af334b73bd8050a123e19e6a373685808 Mon Sep 17 00:00:00 2001 From: Gabor Kiss-Vamosi Date: Thu, 17 Mar 2022 13:47:54 +0100 Subject: [PATCH] chore(docs): fix links --- docs/CONTRIBUTING.md | 2 +- docs/conf.py | 2 +- docs/get-started/{binding => bindings}/cpp.md | 2 +- docs/get-started/{binding => bindings}/index.md | 0 docs/get-started/{binding => bindings}/micropython.md | 0 docs/get-started/os/zephyr.md | 2 +- docs/get-started/platforms/index.md | 2 +- docs/header.rst | 2 +- docs/others/gridnav.md | 4 ++-- docs/porting/project.md | 2 +- 10 files changed, 9 insertions(+), 9 deletions(-) rename docs/get-started/{binding => bindings}/cpp.md (96%) rename docs/get-started/{binding => bindings}/index.md (100%) rename docs/get-started/{binding => bindings}/micropython.md (100%) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0d577894a..b54398c32 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -183,7 +183,7 @@ So with this, you already helped a lot! ### Tell what you have achieved -Have you already started using LVGL in a [Simulator](/get-started/pc-simulator), a development board, or on your custom hardware? +Have you already started using LVGL in a [Simulator](/get-started/platforms/pc-simulator), a development board, or on your custom hardware? Was it easy or were there some obstacles? Are you happy with the result? Showing your project to others is a win-win situation because it increases your and LVGL's reputation at the same time. diff --git a/docs/conf.py b/docs/conf.py index deb3eb30e..c07d8866b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -114,7 +114,7 @@ html_theme_options = { 'logo_only': True, } # For site map generation -html_baseurl = 'https://docs.lvgl.io/' + version + "/" +html_baseurl = 'https://docs.lvgl.io/master/en/html/' sitemap_url_scheme = "{link}" # Add any paths that contain custom static files (such as style sheets) here, diff --git a/docs/get-started/binding/cpp.md b/docs/get-started/bindings/cpp.md similarity index 96% rename from docs/get-started/binding/cpp.md rename to docs/get-started/bindings/cpp.md index 0d451350d..ade9be595 100644 --- a/docs/get-started/binding/cpp.md +++ b/docs/get-started/bindings/cpp.md @@ -2,7 +2,7 @@ .. include:: /header.rst :github_url: |github_link_base|/get-started/bindings/micropython.md ``` -#Cpp +# Cpp In progress: https://github.com/lvgl/lv_binding_cpp diff --git a/docs/get-started/binding/index.md b/docs/get-started/bindings/index.md similarity index 100% rename from docs/get-started/binding/index.md rename to docs/get-started/bindings/index.md diff --git a/docs/get-started/binding/micropython.md b/docs/get-started/bindings/micropython.md similarity index 100% rename from docs/get-started/binding/micropython.md rename to docs/get-started/bindings/micropython.md diff --git a/docs/get-started/os/zephyr.md b/docs/get-started/os/zephyr.md index 996775d5a..32abd3d2d 100644 --- a/docs/get-started/os/zephyr.md +++ b/docs/get-started/os/zephyr.md @@ -2,6 +2,6 @@ .. include:: /header.rst :github_url: |github_link_base|/get-started/os/zephyr.md ``` -# FreeRTOS +# Zephyr TODO \ No newline at end of file diff --git a/docs/get-started/platforms/index.md b/docs/get-started/platforms/index.md index 4ac7106ea..b0ac313a7 100644 --- a/docs/get-started/platforms/index.md +++ b/docs/get-started/platforms/index.md @@ -10,8 +10,8 @@ :maxdepth: 2 pc-simulator - stm32 nxp + stm32 espressif arduino tasmota-berry diff --git a/docs/header.rst b/docs/header.rst index 030069f52..1ae003bae 100644 --- a/docs/header.rst +++ b/docs/header.rst @@ -1 +1 @@ -.. |github_link_base| replace:: https://github.com/lvgl/lvgl/blob/c6f99ad200c7862c2f3cca3811bc2bdc2c95e971/docs \ No newline at end of file +.. |github_link_base| replace:: https://github.com/lvgl/lvgl/blob/8a8153219163b689e8f96d6a97c1f128eefd7ce2/docs \ No newline at end of file diff --git a/docs/others/gridnav.md b/docs/others/gridnav.md index 3d9acb6b6..45bf5fce0 100644 --- a/docs/others/gridnav.md +++ b/docs/others/gridnav.md @@ -10,10 +10,10 @@ If the children are arranged into a grid-like layout then the up, down, left and in the respective direction. It doesn't matter how the children are positioned, as only the current x and y coordinates are considered. -This means that gridnav works with manually positioned children, as well as [Flex](/layouts/flex.html) and [Grid](/layouts/grid.html) layouts. +This means that gridnav works with manually positioned children, as well as [Flex](/layouts/flex) and [Grid](/layouts/grid) layouts. Gridnav also works if the children are arranged into a single row or column. -That makes it useful, for example, to simplify navigation on a [List widget](/widgets/extra/list.html). +That makes it useful, for example, to simplify navigation on a [List widget](/widgets/extra/list). Gridnav assumes that the object to which gridnav is added is part of a [group](/overview/indev.html#groups). This way, if the object with gridnav is focused, the arrow key presses are automatically forwarded to the object diff --git a/docs/porting/project.md b/docs/porting/project.md index c11cbf2cb..3c1076abe 100644 --- a/docs/porting/project.md +++ b/docs/porting/project.md @@ -26,7 +26,7 @@ LVGL_DIR ?= ${shell pwd} #The path where the lvgl folder is include $(LVGL_DIR)/$(LVGL_DIR_NAME)/lvgl.mk ``` -For integration with CMake take a look this section of the [Documentation](/get-started/cmake). +For integration with CMake take a look this section of the [Documentation](/get-started/platforms/cmake). ### Other platforms and tools The [Get started](/get-started/index.html) section contains many platform specific descriptions e.g. for ESP32, Arduino, NXP, RT-Thread, NuttX, etc.