From 3c39c39c9dbefdc3729474c33a0dd3cb8f585e3d Mon Sep 17 00:00:00 2001 From: Gabor Kiss-Vamosi Date: Mon, 3 May 2021 11:13:43 +0200 Subject: [PATCH] docs separate widgets into core and extra groups --- docs/conf.py | 2 +- docs/widgets/{ => core}/arc.md | 0 docs/widgets/{ => core}/bar.md | 0 docs/widgets/{ => core}/btn.md | 0 docs/widgets/{ => core}/btnmatrix.md | 0 docs/widgets/{ => core}/canvas.md | 0 docs/widgets/{ => core}/checkbox.md | 0 docs/widgets/{ => core}/dropdown.md | 0 docs/widgets/{ => core}/img.md | 0 docs/widgets/core/index.md | 29 +++++++++++++++++++++++ docs/widgets/{ => core}/label.md | 0 docs/widgets/{ => core}/line.md | 0 docs/widgets/{ => core}/roller.md | 0 docs/widgets/{ => core}/slider.md | 0 docs/widgets/{ => core}/switch.md | 0 docs/widgets/{ => core}/table.md | 0 docs/widgets/{ => extra}/calendar.md | 0 docs/widgets/{ => extra}/chart.md | 0 docs/widgets/{ => extra}/cpicker.md | 0 docs/widgets/{ => extra}/imgbtn.md | 0 docs/widgets/extra/index.md | 29 +++++++++++++++++++++++ docs/widgets/{ => extra}/keyboard.md | 0 docs/widgets/{ => extra}/led.md | 0 docs/widgets/{ => extra}/list.md | 0 docs/widgets/{ => extra}/msgbox.md | 0 docs/widgets/{ => extra}/spinbox.md | 0 docs/widgets/{ => extra}/spinner.md | 0 docs/widgets/{ => extra}/tabview.md | 0 docs/widgets/{ => extra}/textarea.md | 0 docs/widgets/{ => extra}/tileview.md | 0 docs/widgets/{ => extra}/win.md | 0 docs/widgets/index.md | 35 ++-------------------------- 32 files changed, 61 insertions(+), 34 deletions(-) rename docs/widgets/{ => core}/arc.md (100%) rename docs/widgets/{ => core}/bar.md (100%) rename docs/widgets/{ => core}/btn.md (100%) rename docs/widgets/{ => core}/btnmatrix.md (100%) rename docs/widgets/{ => core}/canvas.md (100%) rename docs/widgets/{ => core}/checkbox.md (100%) rename docs/widgets/{ => core}/dropdown.md (100%) rename docs/widgets/{ => core}/img.md (100%) create mode 100644 docs/widgets/core/index.md rename docs/widgets/{ => core}/label.md (100%) rename docs/widgets/{ => core}/line.md (100%) rename docs/widgets/{ => core}/roller.md (100%) rename docs/widgets/{ => core}/slider.md (100%) rename docs/widgets/{ => core}/switch.md (100%) rename docs/widgets/{ => core}/table.md (100%) rename docs/widgets/{ => extra}/calendar.md (100%) rename docs/widgets/{ => extra}/chart.md (100%) rename docs/widgets/{ => extra}/cpicker.md (100%) rename docs/widgets/{ => extra}/imgbtn.md (100%) create mode 100644 docs/widgets/extra/index.md rename docs/widgets/{ => extra}/keyboard.md (100%) rename docs/widgets/{ => extra}/led.md (100%) rename docs/widgets/{ => extra}/list.md (100%) rename docs/widgets/{ => extra}/msgbox.md (100%) rename docs/widgets/{ => extra}/spinbox.md (100%) rename docs/widgets/{ => extra}/spinner.md (100%) rename docs/widgets/{ => extra}/tabview.md (100%) rename docs/widgets/{ => extra}/textarea.md (100%) rename docs/widgets/{ => extra}/tileview.md (100%) rename docs/widgets/{ => extra}/win.md (100%) diff --git a/docs/conf.py b/docs/conf.py index 060ca1b02d..4f0b0d8a67 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -76,7 +76,7 @@ author = 'The community of LVGL' # The short X.Y version. # embeddedt: extract using scripts/find_version.sh -version = subprocess.run(["../scripts/find_version.sh"], capture_output=True).stdout.decode("utf-8").strip() +version = "v10.1" #subprocess.run(["../scripts/find_version.sh"], capture_output=True).stdout.decode("utf-8").strip() # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/widgets/arc.md b/docs/widgets/core/arc.md similarity index 100% rename from docs/widgets/arc.md rename to docs/widgets/core/arc.md diff --git a/docs/widgets/bar.md b/docs/widgets/core/bar.md similarity index 100% rename from docs/widgets/bar.md rename to docs/widgets/core/bar.md diff --git a/docs/widgets/btn.md b/docs/widgets/core/btn.md similarity index 100% rename from docs/widgets/btn.md rename to docs/widgets/core/btn.md diff --git a/docs/widgets/btnmatrix.md b/docs/widgets/core/btnmatrix.md similarity index 100% rename from docs/widgets/btnmatrix.md rename to docs/widgets/core/btnmatrix.md diff --git a/docs/widgets/canvas.md b/docs/widgets/core/canvas.md similarity index 100% rename from docs/widgets/canvas.md rename to docs/widgets/core/canvas.md diff --git a/docs/widgets/checkbox.md b/docs/widgets/core/checkbox.md similarity index 100% rename from docs/widgets/checkbox.md rename to docs/widgets/core/checkbox.md diff --git a/docs/widgets/dropdown.md b/docs/widgets/core/dropdown.md similarity index 100% rename from docs/widgets/dropdown.md rename to docs/widgets/core/dropdown.md diff --git a/docs/widgets/img.md b/docs/widgets/core/img.md similarity index 100% rename from docs/widgets/img.md rename to docs/widgets/core/img.md diff --git a/docs/widgets/core/index.md b/docs/widgets/core/index.md new file mode 100644 index 0000000000..4d28343e2b --- /dev/null +++ b/docs/widgets/core/index.md @@ -0,0 +1,29 @@ +```eval_rst +.. include:: /header.rst +:github_url: |github_link_base|/object-types/index.md +``` +# Core widgets + +```eval_rst + +.. toctree:: + :maxdepth: 1 + + arc + bar + btn + btnmatrix + canvas + checkbox + dropdown + img + label + line + roller + slider + switch + table + +``` + + diff --git a/docs/widgets/label.md b/docs/widgets/core/label.md similarity index 100% rename from docs/widgets/label.md rename to docs/widgets/core/label.md diff --git a/docs/widgets/line.md b/docs/widgets/core/line.md similarity index 100% rename from docs/widgets/line.md rename to docs/widgets/core/line.md diff --git a/docs/widgets/roller.md b/docs/widgets/core/roller.md similarity index 100% rename from docs/widgets/roller.md rename to docs/widgets/core/roller.md diff --git a/docs/widgets/slider.md b/docs/widgets/core/slider.md similarity index 100% rename from docs/widgets/slider.md rename to docs/widgets/core/slider.md diff --git a/docs/widgets/switch.md b/docs/widgets/core/switch.md similarity index 100% rename from docs/widgets/switch.md rename to docs/widgets/core/switch.md diff --git a/docs/widgets/table.md b/docs/widgets/core/table.md similarity index 100% rename from docs/widgets/table.md rename to docs/widgets/core/table.md diff --git a/docs/widgets/calendar.md b/docs/widgets/extra/calendar.md similarity index 100% rename from docs/widgets/calendar.md rename to docs/widgets/extra/calendar.md diff --git a/docs/widgets/chart.md b/docs/widgets/extra/chart.md similarity index 100% rename from docs/widgets/chart.md rename to docs/widgets/extra/chart.md diff --git a/docs/widgets/cpicker.md b/docs/widgets/extra/cpicker.md similarity index 100% rename from docs/widgets/cpicker.md rename to docs/widgets/extra/cpicker.md diff --git a/docs/widgets/imgbtn.md b/docs/widgets/extra/imgbtn.md similarity index 100% rename from docs/widgets/imgbtn.md rename to docs/widgets/extra/imgbtn.md diff --git a/docs/widgets/extra/index.md b/docs/widgets/extra/index.md new file mode 100644 index 0000000000..333089508d --- /dev/null +++ b/docs/widgets/extra/index.md @@ -0,0 +1,29 @@ +```eval_rst +.. include:: /header.rst +:github_url: |github_link_base|/object-types/index.md +``` +# Extra widgets + +```eval_rst + +.. toctree:: + :maxdepth: 1 + + calendar + chart + colorwheel + imgbtn + keyboard + led + list + meter + msgbox + spinbox + spinner + tabview + textarea + tileview + win +``` + + diff --git a/docs/widgets/keyboard.md b/docs/widgets/extra/keyboard.md similarity index 100% rename from docs/widgets/keyboard.md rename to docs/widgets/extra/keyboard.md diff --git a/docs/widgets/led.md b/docs/widgets/extra/led.md similarity index 100% rename from docs/widgets/led.md rename to docs/widgets/extra/led.md diff --git a/docs/widgets/list.md b/docs/widgets/extra/list.md similarity index 100% rename from docs/widgets/list.md rename to docs/widgets/extra/list.md diff --git a/docs/widgets/msgbox.md b/docs/widgets/extra/msgbox.md similarity index 100% rename from docs/widgets/msgbox.md rename to docs/widgets/extra/msgbox.md diff --git a/docs/widgets/spinbox.md b/docs/widgets/extra/spinbox.md similarity index 100% rename from docs/widgets/spinbox.md rename to docs/widgets/extra/spinbox.md diff --git a/docs/widgets/spinner.md b/docs/widgets/extra/spinner.md similarity index 100% rename from docs/widgets/spinner.md rename to docs/widgets/extra/spinner.md diff --git a/docs/widgets/tabview.md b/docs/widgets/extra/tabview.md similarity index 100% rename from docs/widgets/tabview.md rename to docs/widgets/extra/tabview.md diff --git a/docs/widgets/textarea.md b/docs/widgets/extra/textarea.md similarity index 100% rename from docs/widgets/textarea.md rename to docs/widgets/extra/textarea.md diff --git a/docs/widgets/tileview.md b/docs/widgets/extra/tileview.md similarity index 100% rename from docs/widgets/tileview.md rename to docs/widgets/extra/tileview.md diff --git a/docs/widgets/win.md b/docs/widgets/extra/win.md similarity index 100% rename from docs/widgets/win.md rename to docs/widgets/extra/win.md diff --git a/docs/widgets/index.md b/docs/widgets/index.md index 124e71b1ed..4bff9163fd 100644 --- a/docs/widgets/index.md +++ b/docs/widgets/index.md @@ -10,39 +10,8 @@ :maxdepth: 1 obj - arc - bar - btn - btnmatrix - calendar - canvas - checkbox - chart - cont - cpicker - dropdown - gauge - img - imgbtn - keyboard - label - led - line - list - linemeter - msgbox - objmask - page - roller - slider - spinbox - spinner - switch - table - tabview - textarea - tileview - win + core/index + extra/index ```