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

2023-05-08 08:45:28 -06:00
parent 756c189519
commit 8c99b359d2
27 changed files with 1364 additions and 1367 deletions
--- a/docs/CHANGELOG.rst
+++ b/docs/CHANGELOG.rst
--- a/docs/conf.py
+++ b/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.
--- a/docs/libs/barcode.rst
+++ b/docs/libs/barcode.rst
@@ -35,6 +35,5 @@ Example
 API
 ---

-:ref:`lv_barcode`
-
 :ref:`code128`
+
--- a/docs/libs/bmp.rst
+++ b/docs/libs/bmp.rst
@@ -42,4 +42,3 @@ Example
 API
 ---

-:ref:`lv_bmp`
--- a/docs/libs/ffmpeg.rst
+++ b/docs/libs/ffmpeg.rst
@@ -37,4 +37,3 @@ Example
 API
 ---

-:ref:`lv_ffmpeg`
--- a/docs/libs/freetype.rst
+++ b/docs/libs/freetype.rst
@@ -105,8 +105,7 @@ Learn more
 API
 ---

-:ref:`lv_freetype`
-
 :ref:`ftoption`

 :ref:`ftmodule`
+
--- a/docs/libs/fs.rst
+++ b/docs/libs/fs.rst
@@ -32,4 +32,3 @@ number of actual reads from the storage.
 API
 ***

-:ref:`lv_fsdrv`
--- a/docs/libs/gif.rst
+++ b/docs/libs/gif.rst
@@ -50,6 +50,5 @@ Example
 API
 ---

-:ref:`lv_gif`
-
 :ref:`gifdec`
+
--- a/docs/libs/png.rst
+++ b/docs/libs/png.rst
@@ -26,6 +26,5 @@ Example
 API
 ---

-:ref:`lv_png`
-
 :ref:`lodepng`
+
--- a/docs/libs/qrcode.rst
+++ b/docs/libs/qrcode.rst
@@ -32,6 +32,5 @@ Example
 API
 ---

-:ref:`lv_qrcode`
-
 :ref:`qrcodegen`
+
--- a/docs/libs/rlottie.rst
+++ b/docs/libs/rlottie.rst
@@ -273,5 +273,3 @@ Example

 API
 ---
-
-:ref:`lv_rlottie`
--- a/docs/libs/tiny_ttf.rst
+++ b/docs/libs/tiny_ttf.rst
@@ -39,8 +39,7 @@ Example
 API
 ---

-:ref:`lv_tiny_ttf`
-
 :ref:`stb_rect_pack`

 :ref:`stb_truetype_htcw`
+
--- a/docs/others/file_explorer.rst
+++ b/docs/others/file_explorer.rst
@@ -296,4 +296,3 @@ Example
 API
 ---

-:ref:`lv_file_explorer`
--- a/docs/others/fragment.rst
+++ b/docs/others/fragment.rst
@@ -77,4 +77,3 @@ Example
 API
 ---

-:ref:`lv_fragment`
--- a/docs/others/gridnav.rst
+++ b/docs/others/gridnav.rst
@@ -64,4 +64,3 @@ Example
 API
 ---

-:ref:`lv_gridnav`
--- a/docs/others/ime_pinyin.rst
+++ b/docs/others/ime_pinyin.rst
@@ -311,4 +311,3 @@ Example
 API
 ---

-:ref:`lv_ime_pinyin`
--- a/docs/others/imgfont.rst
+++ b/docs/others/imgfont.rst
@@ -26,5 +26,3 @@ Example

 API
 ---
-
-:ref:`lv_imgfont`
--- a/docs/others/monkey.rst
+++ b/docs/others/monkey.rst
@@ -37,4 +37,3 @@ Example
 API
 ---

-:ref:`lv_monkey`
--- a/docs/others/msg.rst
+++ b/docs/others/msg.rst
@@ -149,5 +149,3 @@ Example

 API
 ---
-
-:ref:`lv_msg`
--- a/docs/others/snapshot.rst
+++ b/docs/others/snapshot.rst
@@ -63,4 +63,3 @@ Example
 API
 ---

-:ref:`lv_snapshot`
--- a/docs/overview/renderers/vglite.rst
+++ b/docs/overview/renderers/vglite.rst
@@ -15,6 +15,3 @@ API

 :ref:`lv_draw_vglite_rect`

-:ref:`lv_vglite_buf`
-
-:ref:`lv_vglite_utils`
--- a/docs/widgets/animimg.rst
+++ b/docs/widgets/animimg.rst
@@ -49,3 +49,5 @@ Example

 API
 ***
+
+:ref:`lv_animimg`
--- a/docs/widgets/arc.rst
+++ b/docs/widgets/arc.rst
@@ -167,3 +167,5 @@ Example

 API
 ***
+
+:ref:`lv_arc`
--- a/docs/widgets/bar.rst
+++ b/docs/widgets/bar.rst
@@ -80,3 +80,5 @@ Example

 API
 ***
+
+:ref:`lv_bar`