docs: fixes several issues related to migrating to rst (#4213)

.github/workflows/release.yml

@@ -22,6 +22,6 @@ jobs:
           tag_name: ${{ github.ref }}
           release_name: Release ${{ github.ref }}
           body: |
-            See the [CHANGELOG](https://github.com/lvgl/lvgl/blob/master/docs/CHANGELOG.md)
+            See the `CHANGELOG <https://github.com/lvgl/lvgl/blob/master/docs/CHANGELOG.rst>`__
           draft: false
           prerelease: false

docs/conf.py

@@ -18,15 +18,10 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
-import subprocess
 import sys
 
 sys.path.insert(0, os.path.abspath('./_ext'))
 
-# from subprocess import PIPE, Popen
-
-# import recommonmark
-# from recommonmark.transform import AutoStructify
 from sphinx.builders.html import StandaloneHTMLBuilder
 
 # -- General configuration ------------------------------------------------
@@ -43,8 +38,6 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
-    # 'recommonmark',
-    # 'sphinx_markdown_tables',
     'breathe',
     'sphinx_sitemap',
     'lv_example',
@@ -65,7 +58,7 @@ highlight_language = 'c'
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_suffix = ['.rst']# , '.md']
+source_suffix = ['.rst']
 
 
 # The master toctree document.
@@ -266,7 +259,7 @@ StandaloneHTMLBuilder.supported_image_types = [
 
 smartquotes = False
 
-_, repo_commit_hash = subprocess.getstatusoutput("git rev-parse HEAD")
+repo_commit_hash = os.environ['LVGL_GITCOMMIT']
 
 
 # Example configuration for intersphinx: refer to the Python standard library.

docs/libs/barcode.rst

@@ -35,6 +35,5 @@ Example
 API
 ---
 
-:ref:`lv_barcode`
-
 :ref:`code128`
+

docs/libs/bmp.rst

@@ -42,4 +42,3 @@ Example
 API
 ---
 
-:ref:`lv_bmp`

docs/libs/ffmpeg.rst

@@ -37,4 +37,3 @@ Example
 API
 ---
 
-:ref:`lv_ffmpeg`

docs/libs/freetype.rst

@@ -105,8 +105,7 @@ Learn more
 API
 ---
 
-:ref:`lv_freetype`
-
 :ref:`ftoption`
 
 :ref:`ftmodule`
+

docs/libs/fs.rst

@@ -32,4 +32,3 @@ number of actual reads from the storage.
 API
 ***
 
-:ref:`lv_fsdrv`

docs/libs/gif.rst

@@ -50,6 +50,5 @@ Example
 API
 ---
 
-:ref:`lv_gif`
-
 :ref:`gifdec`
+

docs/libs/png.rst

@@ -26,6 +26,5 @@ Example
 API
 ---
 
-:ref:`lv_png`
-
 :ref:`lodepng`
+

docs/libs/qrcode.rst

@@ -32,6 +32,5 @@ Example
 API
 ---
 
-:ref:`lv_qrcode`
-
 :ref:`qrcodegen`
+

docs/libs/rlottie.rst

@@ -273,5 +273,3 @@ Example
 
 API
 ---
-
-:ref:`lv_rlottie`

docs/libs/tiny_ttf.rst

@@ -39,8 +39,7 @@ Example
 API
 ---
 
-:ref:`lv_tiny_ttf`
-
 :ref:`stb_rect_pack`
 
 :ref:`stb_truetype_htcw`
+

docs/others/file_explorer.rst

@@ -296,4 +296,3 @@ Example
 API
 ---
 
-:ref:`lv_file_explorer`

docs/others/fragment.rst

@@ -77,4 +77,3 @@ Example
 API
 ---
 
-:ref:`lv_fragment`

docs/others/gridnav.rst

@@ -64,4 +64,3 @@ Example
 API
 ---
 
-:ref:`lv_gridnav`

docs/others/ime_pinyin.rst

@@ -311,4 +311,3 @@ Example
 API
 ---
 
-:ref:`lv_ime_pinyin`

docs/others/imgfont.rst

@@ -26,5 +26,3 @@ Example
 
 API
 ---
-
-:ref:`lv_imgfont`

docs/others/monkey.rst

@@ -37,4 +37,3 @@ Example
 API
 ---
 
-:ref:`lv_monkey`

docs/others/msg.rst

@@ -149,5 +149,3 @@ Example
 
 API
 ---
-
-:ref:`lv_msg`

docs/others/snapshot.rst

@@ -63,4 +63,3 @@ Example
 API
 ---
 
-:ref:`lv_snapshot`

docs/overview/renderers/vglite.rst

@@ -15,6 +15,3 @@ API
 
 :ref:`lv_draw_vglite_rect`
 
-:ref:`lv_vglite_buf`
-
-:ref:`lv_vglite_utils`

docs/widgets/animimg.rst

@@ -49,3 +49,5 @@ Example
 
 API
 ***
+
+:ref:`lv_animimg`

docs/widgets/arc.rst

@@ -167,3 +167,5 @@ Example
 
 API
 ***
+
+:ref:`lv_arc`

docs/widgets/bar.rst

@@ -80,3 +80,5 @@ Example
 
 API
 ***
+
+:ref:`lv_bar`

scripts/changelog-template.hbs

@@ -1,106 +1,122 @@
 {{#each releases}}
-  ## [{{title}}]({{href}}) {{niceDate}}
+  `{{title}} <{{href}}>`__ {{niceDate}}
+  ---------------------------------------------------------------------------------------------------
+
+  Breaking Changes
+  ~~~~~~~~~~~~~~~~
   
-  ### Breaking Changes
   {{#commit-list merges heading='' message='BREAKING CHANGE'}}
-    - :warning: {{message}} [`{{id}}`]({{href}})
+    - .. warning: {{message}} `{{id}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list commits heading='' message='BREAKING CHANGE'}}
-    - :warning: {{subject}} [`{{shorthash}}`]({{href}})
+    - .. warning: {{subject}} `{{shorthash}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list fixes heading='' message='BREAKING CHANGE'}}
-    - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
+    - **{{commit.subject}}**  `{{commit.shorthash}} <{{commit.href}}>`__
   {{/commit-list}}
 
-  ### Architectural
+  Architectural
+  ~~~~~~~~~~~~~
+  
   {{#commit-list merges heading='' message='^arch' exclude='BREAKING CHANGE'}}
-    - {{message}} [`{{id}}`]({{href}})
+    - **{{message}}** `{{id}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list commits heading='' message='^arch' exclude='BREAKING CHANGE'}}
-    - {{subject}} [`{{shorthash}}`]({{href}})
+    - **{{subject}}** `{{shorthash}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list fixes heading='' message='^arch' exclude='BREAKING CHANGE'}}
-    - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
+    - **{{commit.subject}}**  `{{commit.shorthash}} <{{commit.href}}>`__
   {{/commit-list}}
 
-  ### New Features
+  New Features
+  ~~~~~~~~~~~~
+  
   {{#commit-list merges heading='' message='^feat' exclude='BREAKING CHANGE'}}
-    - {{message}} [`{{id}}`]({{href}})
+    - **{{message}}** `{{id}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list commits heading='' message='^feat' exclude='BREAKING CHANGE'}}
-    - {{subject}} [`{{shorthash}}`]({{href}})
+    - **{{subject}}** `{{shorthash}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list fixes heading='' message='^feat' exclude='BREAKING CHANGE'}}
-    - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
+    - **{{commit.subject}}**  `{{commit.shorthash}} <{{commit.href}}>`__
   {{/commit-list}}
 
+  Performance
+  ~~~~~~~~~~~
   
-  ### Performance
   {{#commit-list merges heading='' message='^perf' exclude='BREAKING CHANGE'}}
-    - {{message}} [`{{id}}`]({{href}})
+    - **{{message}}** `{{id}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list commits heading='' message='^perf' exclude='BREAKING CHANGE'}}
-    - {{subject}} [`{{shorthash}}`]({{href}})
+    - **{{subject}}** `{{shorthash}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list fixes heading='' message='^perf' exclude='BREAKING CHANGE'}}
-    - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
+    - **{{commit.subject}}**  `{{commit.shorthash}} <{{commit.href}}>`__
   {{/commit-list}}
 
-  ### Fixes
+  Fixes
+  ~~~~~
+  
   {{#commit-list merges heading='' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE)'}}
-    - {{message}} [`{{id}}`]({{href}})
+    - **{{message}}** `{{id}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list commits heading='' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE)'}}
-    - {{subject}} [`{{shorthash}}`]({{href}})
+    - **{{subject}}** `{{shorthash}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list fixes heading=''  message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE)'}}
-    - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
+    - **{{commit.subject}}**  `{{commit.shorthash}} <{{commit.href}}>`__
   {{/commit-list}}
 
+  Examples
+  ~~~~~~~~
   
-  ### Examples
   {{#commit-list merges heading='' message='^example'}}
-    - {{message}} [`{{id}}`]({{href}})
+    - **{{message}}** `{{id}} <({{href}})>`__
   {{/commit-list}}
   {{#commit-list commits heading='' message='^example'}}
-    - {{subject}} [`{{shorthash}}`]({{href}})
+    - **{{subject}}** `{{shorthash}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list fixes heading='' message='^example'}}
-    - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
+    - **{{commit.subject}}**  `{{commit.shorthash}} <{{commit.href}}>`__
   {{/commit-list}}
 
+  Docs
+  ~~~~
   
-  ### Docs
   {{#commit-list merges heading='' message='^docs'}}
-    - {{message}} [`{{id}}`]({{href}})
+    - **{{message}}** `{{id}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list commits heading='' message='^docs'}}
-    - {{subject}} [`{{shorthash}}`]({{href}})
+    - **{{subject}}** `{{shorthash}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list fixes heading='' message='^docs'}}
-    - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
+    - **{{commit.subject}}**  `{{commit.shorthash}} <{{commit.href}}>`__
   {{/commit-list}}
 
-  ### CI and tests
+  CI and tests
+  ~~~~~~~~~~~~
+  
   {{#commit-list merges heading='' message='(^ci|^test)'}}
-    - {{message}} [`{{id}}`]({{href}})
+    - **{{message}}** `{{id}} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list commits heading='' message='(^ci|^test)'}}
-    - {{subject}} [`{{shorthash}}`]({{href}})
+    - **{{subject}}** `{{shorthash }} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list fixes heading='' message='(^ci|^test)'}}
-    - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
+    - **{{commit.subject}}**  `{{commit.shorthash}} <{{commit.href}}>`__
   {{/commit-list}}
 
-  ### Others
+  Others
+  ~~~~~~
+  
   {{#commit-list merges heading='' exclude='(^fix|^feat|^perf|^docs|^example|^ci|^test)'}}
-    - {{message}} [`{{id}}`]({{href}})
+    - **{{message}}** `{{id }} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list commits heading='' exclude='(^fix|^feat|^perf|^docs|^example|^ci|^test)'}}
-    - {{subject}} [`{{shorthash}}`]({{href}})
+    - **{{subject}}** `{{shorthash }} <{{href}}>`__
   {{/commit-list}}
   {{#commit-list fixes heading=''  exclude='(^fix|^feat|^perf|^docs|^example|^ci|^test)'}}
-    - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
+    - **{{commit.subject}}**  `{{commit.shorthash}} <{{commit.href}}>`__
   {{/commit-list}}
 
 {{/each}}

scripts/changelog_gen.sh

@@ -12,4 +12,4 @@
 #    changelog-gen v5.7.0
 #    changelog-gen v6.0.0
 
-auto-changelog -t changelog-template.hbs -l false --latest-version $1 --unreleased-only  --tag-pattern ^v[0-9]+.[0-9]+.[0-9]+$ -o CHANGELOG_LAST.md
+auto-changelog -t changelog-template.hbs -l false --latest-version $1 --unreleased-only  --tag-pattern ^v[0-9]+.[0-9]+.[0-9]+$ -o CHANGELOG_LAST.rst