Provide a copy of 'en' folders and files together with '..include::' links inside files as preparation for translation of this site into Chinese.

Author: krzychb

.gitignore

@@ -33,6 +33,10 @@ docs/*/xml_in/
 docs/*/man/
 docs/*/doxygen_sqlite3.db
 
+# Downloaded font files
+docs/_static/DejaVuSans.ttf
+docs/_static/NotoSansSC-Regular.otf
+
 # gcov coverage reports
 *.gcda
 *.gcno

.gitlab-ci.yml

@@ -122,17 +122,29 @@ build_docs:
   artifacts:
     when: always
     paths:
+      # English version of documentation
       - docs/en/doxygen-warning-log.txt
       - docs/en/sphinx-warning-log.txt
       - docs/en/sphinx-warning-log-sanitized.txt
       - docs/en/_build/html
+      - docs/sphinx-err-*
+      # Chinese version of documentation
+      - docs/zh_CN/doxygen-warning-log.txt
+      - docs/zh_CN/sphinx-warning-log.txt
+      - docs/zh_CN/sphinx-warning-log-sanitized.txt
+      - docs/zh_CN/_build/html
     expire_in: 1 mos
   script:
-    - cd docs/en
+    - cd docs
+    - ./check_lang_folder_sync.sh
+    - cd en
+    - make gh-linkcheck
+    - make html
+    - ../check_doc_warnings.sh
+    - cd ../zh_CN
     - make gh-linkcheck
     - make html
     - ../check_doc_warnings.sh
-
 assign_test:
   tags:
     - assign_test

docs/README.md

@@ -1,7 +1,31 @@
-# Documentation Source Folder
-
-This folder contains source files of [ESP-ADF documentation](https://docs.espressif.com/projects/esp-adf/en/latest/)
-
-The sources do not render well in GitHub and some information is not visible at all.
-
-Use actual documentation generated within about 20 minutes on each commit under https://docs.espressif.com/projects/esp-adf/en/latest/
+# Documentation Source Folder
+
+This folder contains source files of **ESP-ADF documentation** available in [English](https://docs.espressif.com/projects/esp-adf/en/latest/) and [中文](https://docs.espressif.com/projects/esp-adf/zh_CN/latest/).
+
+The sources do not render well in GitHub and some information is not visible at all.
+
+Use actual documentation generated within about 20 minutes on each commit:
+
+# Hosted Documentation
+
+* English: https://docs.espressif.com/projects/esp-adf/en/latest/
+* 中文: https://docs.espressif.com/projects/esp-adf/zh_CN/latest/
+
+The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.
+
+
+# Building Documentation
+
+* Install `make` and `doxygen` for your platform (`make` may already be installed as an ESP-IDF prerequisite).
+* Change to either the docs/en or docs/zh_CN subdirectory and run `make html`
+* `make` will probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-run `make html` to build the docs.
+
+## For MSYS2 MINGW32 on Windows
+
+If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:
+
+```
+pacman -S doxygen mingw-w64-i686-python2-pillow
+```
+
+Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.