Merge branch 'master' of https://github.com/littlevgl/lvgl

.github/workflows/compile_docs.yml

@@ -34,10 +34,10 @@ jobs:
             !${{ env.pythonLocation }}/lib/python*/site-packages/setuptools*
           key: ${{ env.pythonLocation }}
       - name: Install Doxygen and Latex dependencies
-        run: sudo apt-get install doxygen texlive-xetex
+        run: sudo apt-get install doxygen texlive-xetex texlive-binaries texlive-lang-english latexmk fonts-freefont-otf
       - name: Install requirements
         run: |
-          pip install --upgrade --upgrade-strategy eager sphinx recommonmark commonmark breathe sphinx-rtd-theme sphinx-markdown-tables sphinx-sitemap
+          pip install --upgrade --upgrade-strategy eager Sphinx==3.5.4 breathe==4.30.0 recommonmark==0.6.0 commonmark==0.9.1 sphinx-rtd-theme==0.5.2 sphinx-markdown-tables==0.0.15 sphinx-sitemap==2.2.0
       - name: Setup Emscripten cache
         id: cache-system-libraries
         uses: actions/cache@v2
@@ -48,7 +48,9 @@ jobs:
         with:
           version: ${{env.EM_VERSION}}
           actions-cache-folder: ${{env.EM_CACHE_FOLDER}}
-      - name: Build examples
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1
+      - name: Build examples (with cache)
         run: scripts/build_html_examples.sh
       - name: Build docs
         run: docs/build.py

docs/build.py

@@ -60,7 +60,7 @@ cmd("cd ../scripts && doxygen Doxyfile")
 cmd("sphinx-build -b latex . out_latex")
 
 # Generate PDF
-cmd("cd out_latex && xelatex -interaction=batchmode *.tex")
+cmd("cd out_latex && latexmk -pdf 'LVGL.tex'")
 # Copy the result PDF to the main directory to make it avaiable for the HTML build
 cmd("cd out_latex && cp -f LVGL.pdf ../LVGL.pdf")
 

docs/conf.py

@@ -146,6 +146,8 @@ html_last_updated_fmt = ''
 
 # -- Options for LaTeX output ---------------------------------------------
 
+latex_engine = 'xelatex'
+latex_use_xindy = False
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
@@ -166,6 +168,10 @@ latex_elements = {
     'inputenc': '',
     'utf8extra': '',
     'classoptions': ',openany,oneside',
+    'babel': '\\usepackage{babel}',
+    'passoptionstopackages': r'''
+\PassOptionsToPackage{bookmarksdepth=5}{hyperref}% depth of pdf bookmarks
+''',
     'preamble': r'''
 \usepackage{fontspec}
 \setmonofont{DejaVu Sans Mono}

scripts/build_html_examples.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 set -e
+export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
 CURRENT_REF="$(git rev-parse HEAD)"
 rm -rf emscripten_builder
 git clone https://github.com/lvgl/lv_sim_emscripten.git emscripten_builder
@@ -12,8 +13,8 @@ cd ..
 git submodule update --init -- lv_drivers
 mkdir cmbuild
 cd cmbuild
-emcmake cmake .. -DLVGL_CHOSEN_DEMO=lv_example_noop
+emcmake cmake .. -DLVGL_CHOSEN_DEMO=lv_example_noop -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
-make -j$(nproc)
+emmake make -j$(nproc)
 rm -rf CMakeFiles
 cd ../..
 cp -a emscripten_builder/cmbuild docs/_static/built_lv_examples