espressif
diff --git a/Diff for: ‎.github/workflows/docs.yml
+20-8 b/Diff for: ‎.github/workflows/docs.yml
+20-8
diff --git a/Diff for: ‎.gitignore
+2 b/Diff for: ‎.gitignore
+2
diff --git a/Diff for: ‎docs/Makefile
-28 b/Diff for: ‎docs/Makefile
-28
diff --git a/Diff for: ‎docs/source/_static/arduino-ide.png renamed to ‎docs/_static/arduino-ide.png b/Diff for: ‎docs/source/_static/arduino-ide.png renamed to ‎docs/_static/arduino-ide.png
diff --git a/Diff for: ‎docs/source/_static/arduino_i2c_master.png renamed to ‎docs/_static/arduino_i2c_master.png b/Diff for: ‎docs/source/_static/arduino_i2c_master.png renamed to ‎docs/_static/arduino_i2c_master.png
diff --git a/Diff for: ‎docs/source/_static/arduino_i2c_slave.png renamed to ‎docs/_static/arduino_i2c_slave.png b/Diff for: ‎docs/source/_static/arduino_i2c_slave.png renamed to ‎docs/_static/arduino_i2c_slave.png
diff --git a/Diff for: ‎docs/source/_static/esp32-c3_devkitM-1_pinlayout.png renamed to ‎docs/_static/esp32-c3_devkitM-1_pinlayout.png b/Diff for: ‎docs/source/_static/esp32-c3_devkitM-1_pinlayout.png renamed to ‎docs/_static/esp32-c3_devkitM-1_pinlayout.png
diff --git a/Diff for: ‎docs/source/_static/esp32-s2_saola1_pinlayout.png renamed to ‎docs/_static/esp32-s2_saola1_pinlayout.png b/Diff for: ‎docs/source/_static/esp32-s2_saola1_pinlayout.png renamed to ‎docs/_static/esp32-s2_saola1_pinlayout.png
diff --git a/Diff for: ‎docs/source/_static/esp32_devkitC_pinlayout.png renamed to ‎docs/_static/esp32_devkitC_pinlayout.png b/Diff for: ‎docs/source/_static/esp32_devkitC_pinlayout.png renamed to ‎docs/_static/esp32_devkitC_pinlayout.png
diff --git a/Diff for: ‎docs/source/_static/gpio_output.png renamed to ‎docs/_static/gpio_output.png b/Diff for: ‎docs/source/_static/gpio_output.png renamed to ‎docs/_static/gpio_output.png
diff --git a/Diff for: ‎docs/source/_static/gpio_pullup.png renamed to ‎docs/_static/gpio_pullup.png b/Diff for: ‎docs/source/_static/gpio_pullup.png renamed to ‎docs/_static/gpio_pullup.png
diff --git a/Diff for: ‎docs/source/_static/install_guide_boards_manager_esp32.png renamed to ‎docs/_static/install_guide_boards_manager_esp32.png b/Diff for: ‎docs/source/_static/install_guide_boards_manager_esp32.png renamed to ‎docs/_static/install_guide_boards_manager_esp32.png
diff --git a/Diff for: ‎docs/source/_static/install_guide_boards_manager_url.png renamed to ‎docs/_static/install_guide_boards_manager_url.png b/Diff for: ‎docs/source/_static/install_guide_boards_manager_url.png renamed to ‎docs/_static/install_guide_boards_manager_url.png
diff --git a/Diff for: ‎docs/source/_static/install_guide_preferences.png renamed to ‎docs/_static/install_guide_preferences.png b/Diff for: ‎docs/source/_static/install_guide_preferences.png renamed to ‎docs/_static/install_guide_preferences.png
diff --git a/Diff for: ‎docs/source/_static/logo_arduino.png renamed to ‎docs/_static/logo_arduino.png b/Diff for: ‎docs/source/_static/logo_arduino.png renamed to ‎docs/_static/logo_arduino.png
diff --git a/Diff for: ‎docs/source/_static/logo_espressif.png renamed to ‎docs/_static/logo_espressif.png b/Diff for: ‎docs/source/_static/logo_espressif.png renamed to ‎docs/_static/logo_espressif.png
diff --git a/Diff for: ‎docs/source/_static/logo_linux.png renamed to ‎docs/_static/logo_linux.png b/Diff for: ‎docs/source/_static/logo_linux.png renamed to ‎docs/_static/logo_linux.png
diff --git a/Diff for: ‎docs/source/_static/logo_macos.png renamed to ‎docs/_static/logo_macos.png b/Diff for: ‎docs/source/_static/logo_macos.png renamed to ‎docs/_static/logo_macos.png
diff --git a/Diff for: ‎docs/source/_static/logo_pio.png renamed to ‎docs/_static/logo_pio.png b/Diff for: ‎docs/source/_static/logo_pio.png renamed to ‎docs/_static/logo_pio.png
diff --git a/Diff for: ‎docs/source/_static/logo_windows.png renamed to ‎docs/_static/logo_windows.png b/Diff for: ‎docs/source/_static/logo_windows.png renamed to ‎docs/_static/logo_windows.png
diff --git a/Diff for: ‎docs/source/_static/ota_esp32_login.png renamed to ‎docs/_static/ota_esp32_login.png b/Diff for: ‎docs/source/_static/ota_esp32_login.png renamed to ‎docs/_static/ota_esp32_login.png
diff --git a/Diff for: ‎docs/source/_static/ota_esp32_upload.png renamed to ‎docs/_static/ota_esp32_upload.png b/Diff for: ‎docs/source/_static/ota_esp32_upload.png renamed to ‎docs/_static/ota_esp32_upload.png
diff --git a/Diff for: ‎docs/source/_static/ota_esp32_verbose.png renamed to ‎docs/_static/ota_esp32_verbose.png b/Diff for: ‎docs/source/_static/ota_esp32_verbose.png renamed to ‎docs/_static/ota_esp32_verbose.png
diff --git a/Diff for: ‎docs/source/_static/ota_export_to_binary.png renamed to ‎docs/_static/ota_export_to_binary.png b/Diff for: ‎docs/source/_static/ota_export_to_binary.png renamed to ‎docs/_static/ota_export_to_binary.png
diff --git a/Diff for: ‎docs/source/_static/soc-module.png renamed to ‎docs/_static/soc-module.png b/Diff for: ‎docs/source/_static/soc-module.png renamed to ‎docs/_static/soc-module.png
diff --git a/Diff for: ‎docs/source/_static/tutorials/basic/tutorial_basic_ide.png renamed to ‎docs/_static/tutorials/basic/tutorial_basic_ide.png b/Diff for: ‎docs/source/_static/tutorials/basic/tutorial_basic_ide.png renamed to ‎docs/_static/tutorials/basic/tutorial_basic_ide.png
diff --git a/Diff for: ‎docs/source/_static/tutorials/peripherals/tutorial_peripheral_diagram.png renamed to ‎docs/_static/tutorials/peripherals/tutorial_peripheral_diagram.png b/Diff for: ‎docs/source/_static/tutorials/peripherals/tutorial_peripheral_diagram.png renamed to ‎docs/_static/tutorials/peripherals/tutorial_peripheral_diagram.png
diff --git a/Diff for: ‎docs/source/_static/usb_msc_drive.png renamed to ‎docs/_static/usb_msc_drive.png b/Diff for: ‎docs/source/_static/usb_msc_drive.png renamed to ‎docs/_static/usb_msc_drive.png
diff --git a/Diff for: ‎docs/source/_static/wifi_esp32_ap.png renamed to ‎docs/_static/wifi_esp32_ap.png b/Diff for: ‎docs/source/_static/wifi_esp32_ap.png renamed to ‎docs/_static/wifi_esp32_ap.png
diff --git a/Diff for: ‎docs/source/_static/wifi_esp32_sta.png renamed to ‎docs/_static/wifi_esp32_sta.png b/Diff for: ‎docs/source/_static/wifi_esp32_sta.png renamed to ‎docs/_static/wifi_esp32_sta.png
diff --git a/Diff for: ‎docs/source/_static/win-gui-1.png renamed to ‎docs/_static/win-gui-1.png b/Diff for: ‎docs/source/_static/win-gui-1.png renamed to ‎docs/_static/win-gui-1.png
diff --git a/Diff for: ‎docs/source/_static/win-gui-2.png renamed to ‎docs/_static/win-gui-2.png b/Diff for: ‎docs/source/_static/win-gui-2.png renamed to ‎docs/_static/win-gui-2.png
diff --git a/Diff for: ‎docs/source/_static/win-gui-3.png renamed to ‎docs/_static/win-gui-3.png b/Diff for: ‎docs/source/_static/win-gui-3.png renamed to ‎docs/_static/win-gui-3.png
diff --git a/Diff for: ‎docs/source/_static/win-gui-4.png renamed to ‎docs/_static/win-gui-4.png b/Diff for: ‎docs/source/_static/win-gui-4.png renamed to ‎docs/_static/win-gui-4.png
diff --git a/Diff for: ‎docs/source/_static/win-gui-5.png renamed to ‎docs/_static/win-gui-5.png b/Diff for: ‎docs/source/_static/win-gui-5.png renamed to ‎docs/_static/win-gui-5.png
diff --git a/Diff for: ‎docs/source/_static/win-gui-update-1.png renamed to ‎docs/_static/win-gui-update-1.png b/Diff for: ‎docs/source/_static/win-gui-update-1.png renamed to ‎docs/_static/win-gui-update-1.png
diff --git a/Diff for: ‎docs/source/_static/win-gui-update-2.png renamed to ‎docs/_static/win-gui-update-2.png b/Diff for: ‎docs/source/_static/win-gui-update-2.png renamed to ‎docs/_static/win-gui-update-2.png
diff --git a/Diff for: ‎docs/conf_common.py
+26 b/Diff for: ‎docs/conf_common.py
+26
diff --git a/Diff for: ‎docs/source/advanced_utils.rst renamed to ‎docs/en/advanced_utils.rst b/Diff for: ‎docs/source/advanced_utils.rst renamed to ‎docs/en/advanced_utils.rst
diff --git a/Diff for: ‎docs/source/api/adc.rst renamed to ‎docs/en/api/adc.rst b/Diff for: ‎docs/source/api/adc.rst renamed to ‎docs/en/api/adc.rst
diff --git a/Diff for: ‎docs/source/api/bluetooth.rst renamed to ‎docs/en/api/bluetooth.rst b/Diff for: ‎docs/source/api/bluetooth.rst renamed to ‎docs/en/api/bluetooth.rst
diff --git a/Diff for: ‎docs/source/api/dac.rst renamed to ‎docs/en/api/dac.rst b/Diff for: ‎docs/source/api/dac.rst renamed to ‎docs/en/api/dac.rst
diff --git a/Diff for: ‎docs/source/api/deepsleep.rst renamed to ‎docs/en/api/deepsleep.rst b/Diff for: ‎docs/source/api/deepsleep.rst renamed to ‎docs/en/api/deepsleep.rst
diff --git a/Diff for: ‎docs/source/api/espnow.rst renamed to ‎docs/en/api/espnow.rst b/Diff for: ‎docs/source/api/espnow.rst renamed to ‎docs/en/api/espnow.rst
diff --git a/Diff for: ‎docs/source/api/gpio.rst renamed to ‎docs/en/api/gpio.rst b/Diff for: ‎docs/source/api/gpio.rst renamed to ‎docs/en/api/gpio.rst
diff --git a/Diff for: ‎docs/source/api/i2c.rst renamed to ‎docs/en/api/i2c.rst
+2-2 b/Diff for: ‎docs/source/api/i2c.rst renamed to ‎docs/en/api/i2c.rst
+2-2
diff --git a/Diff for: ‎docs/source/api/i2s.rst renamed to ‎docs/en/api/i2s.rst b/Diff for: ‎docs/source/api/i2s.rst renamed to ‎docs/en/api/i2s.rst
diff --git a/Diff for: ‎docs/source/api/ledc.rst renamed to ‎docs/en/api/ledc.rst b/Diff for: ‎docs/source/api/ledc.rst renamed to ‎docs/en/api/ledc.rst
diff --git a/Diff for: ‎docs/source/api/preferences.rst renamed to ‎docs/en/api/preferences.rst b/Diff for: ‎docs/source/api/preferences.rst renamed to ‎docs/en/api/preferences.rst
diff --git a/Diff for: ‎docs/source/api/rainmaker.rst renamed to ‎docs/en/api/rainmaker.rst b/Diff for: ‎docs/source/api/rainmaker.rst renamed to ‎docs/en/api/rainmaker.rst
diff --git a/Diff for: ‎docs/source/api/reset_reason.rst renamed to ‎docs/en/api/reset_reason.rst b/Diff for: ‎docs/source/api/reset_reason.rst renamed to ‎docs/en/api/reset_reason.rst
diff --git a/Diff for: ‎docs/source/api/sigmadelta.rst renamed to ‎docs/en/api/sigmadelta.rst b/Diff for: ‎docs/source/api/sigmadelta.rst renamed to ‎docs/en/api/sigmadelta.rst
diff --git a/Diff for: ‎docs/source/api/timer.rst renamed to ‎docs/en/api/timer.rst b/Diff for: ‎docs/source/api/timer.rst renamed to ‎docs/en/api/timer.rst
diff --git a/Diff for: ‎docs/source/api/usb.rst renamed to ‎docs/en/api/usb.rst b/Diff for: ‎docs/source/api/usb.rst renamed to ‎docs/en/api/usb.rst
diff --git a/Diff for: ‎docs/source/api/usb_cdc.rst renamed to ‎docs/en/api/usb_cdc.rst b/Diff for: ‎docs/source/api/usb_cdc.rst renamed to ‎docs/en/api/usb_cdc.rst
diff --git a/Diff for: ‎docs/source/api/usb_msc.rst renamed to ‎docs/en/api/usb_msc.rst b/Diff for: ‎docs/source/api/usb_msc.rst renamed to ‎docs/en/api/usb_msc.rst
diff --git a/Diff for: ‎docs/source/api/wifi.rst renamed to ‎docs/en/api/wifi.rst
+2-2 b/Diff for: ‎docs/source/api/wifi.rst renamed to ‎docs/en/api/wifi.rst
+2-2
diff --git a/Diff for: ‎docs/source/boards/ESP32-C3-DevKitM-1.rst renamed to ‎docs/en/boards/ESP32-C3-DevKitM-1.rst
+1-1 b/Diff for: ‎docs/source/boards/ESP32-C3-DevKitM-1.rst renamed to ‎docs/en/boards/ESP32-C3-DevKitM-1.rst
+1-1
diff --git a/Diff for: ‎docs/source/boards/ESP32-DevKitC-1.rst renamed to ‎docs/en/boards/ESP32-DevKitC-1.rst
+1-1 b/Diff for: ‎docs/source/boards/ESP32-DevKitC-1.rst renamed to ‎docs/en/boards/ESP32-DevKitC-1.rst
+1-1
diff --git a/Diff for: ‎docs/source/boards/ESP32-S2-Saola-1.rst renamed to ‎docs/en/boards/ESP32-S2-Saola-1.rst
+1-1 b/Diff for: ‎docs/source/boards/ESP32-S2-Saola-1.rst renamed to ‎docs/en/boards/ESP32-S2-Saola-1.rst
+1-1
diff --git a/Diff for: ‎docs/source/boards/boards.rst renamed to ‎docs/en/boards/boards.rst
+2-2 b/Diff for: ‎docs/source/boards/boards.rst renamed to ‎docs/en/boards/boards.rst
+2-2
diff --git a/Diff for: ‎docs/source/boards/generic.rst renamed to ‎docs/en/boards/generic.rst b/Diff for: ‎docs/source/boards/generic.rst renamed to ‎docs/en/boards/generic.rst
diff --git a/Diff for: ‎docs/source/common/datasheet.inc renamed to ‎docs/en/common/datasheet.inc b/Diff for: ‎docs/source/common/datasheet.inc renamed to ‎docs/en/common/datasheet.inc
diff --git a/Diff for: ‎docs/en/conf.py
+29 b/Diff for: ‎docs/en/conf.py
+29
diff --git a/Diff for: ‎docs/source/contributing.rst renamed to ‎docs/en/contributing.rst b/Diff for: ‎docs/source/contributing.rst renamed to ‎docs/en/contributing.rst
diff --git a/Diff for: ‎docs/source/esp-idf_component.rst renamed to ‎docs/en/esp-idf_component.rst b/Diff for: ‎docs/source/esp-idf_component.rst renamed to ‎docs/en/esp-idf_component.rst
diff --git a/Diff for: ‎docs/source/faq.rst renamed to ‎docs/en/faq.rst b/Diff for: ‎docs/source/faq.rst renamed to ‎docs/en/faq.rst
diff --git a/Diff for: ‎docs/source/getting_started.rst renamed to ‎docs/en/getting_started.rst
+5-5 b/Diff for: ‎docs/source/getting_started.rst renamed to ‎docs/en/getting_started.rst
+5-5
diff --git a/Diff for: ‎docs/source/guides/docs_contributing.rst renamed to ‎docs/en/guides/docs_contributing.rst
+1-1 b/Diff for: ‎docs/source/guides/docs_contributing.rst renamed to ‎docs/en/guides/docs_contributing.rst
+1-1
diff --git a/Diff for: ‎docs/source/guides/guides.rst renamed to ‎docs/en/guides/guides.rst b/Diff for: ‎docs/source/guides/guides.rst renamed to ‎docs/en/guides/guides.rst
diff --git a/Diff for: ‎docs/source/guides/tools_menu.rst renamed to ‎docs/en/guides/tools_menu.rst
+1-1 b/Diff for: ‎docs/source/guides/tools_menu.rst renamed to ‎docs/en/guides/tools_menu.rst
+1-1
diff --git a/Diff for: ‎docs/source/index.rst renamed to ‎docs/en/index.rst
-1 b/Diff for: ‎docs/source/index.rst renamed to ‎docs/en/index.rst
-1
diff --git a/Diff for: ‎docs/source/installing.rst renamed to ‎docs/en/installing.rst
+15-15 b/Diff for: ‎docs/source/installing.rst renamed to ‎docs/en/installing.rst
+15-15
diff --git a/Diff for: ‎docs/source/lib_builder.rst renamed to ‎docs/en/lib_builder.rst b/Diff for: ‎docs/source/lib_builder.rst renamed to ‎docs/en/lib_builder.rst
diff --git a/Diff for: ‎docs/source/libraries.rst renamed to ‎docs/en/libraries.rst b/Diff for: ‎docs/source/libraries.rst renamed to ‎docs/en/libraries.rst
diff --git a/Diff for: ‎docs/source/make.rst renamed to ‎docs/en/make.rst b/Diff for: ‎docs/source/make.rst renamed to ‎docs/en/make.rst
@@ -1,4 +1,4 @@
-name: ReadTheDocs CI
+name: Docs CI
 
 on:
   push:
@@ -15,8 +15,8 @@ on:
 
 jobs:
 
-  build-docs:
-    name: Build ReadTheDocs
+  deploy-preview-docs:
+    name: Deploy Preview Docs
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -28,11 +28,23 @@ jobs:
     - uses: actions/setup-python@v2
       with:
         python-version: '3.x'
-    - name: Build
+    - name: Deploy Preview
+      env:
+        DOCS_BUILD_DIR: "./docs/_build/"
+        DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_DEPLOY_KEY }}
+        DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PREV_SERVER }}
+        DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PREV_SERVER_USER }}
+        DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PREV_PATH }}
+        DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PREV_URL }}
       run: |
         sudo apt update
         sudo apt install python3-pip python3-setuptools
-        # GitHub CI installs pip3 and setuptools outside the path.
-        # Update the path to include them and run.
-        PATH=/home/runner/.local/bin:$PATH pip3 install --user -r ./docs/requirements.txt
-        cd ./docs && PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" make html
+        source ./docs/utils.sh
+        add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
+        export GIT_VER=$(git describe --always)
+        echo "PIP install requirements..."
+        pip3 install --user -r ./docs/requirements.txt
+        echo "Building the Docs..."
+        cd ./docs && build-docs -l en
+        echo "Deploy the Docs..."
+        deploy-docs
@@ -23,6 +23,8 @@ boards.sloeber.txt
 # Ignore docs build (Sphinx)
 docs/build
 docs/source/_build
+docs/__pycache__/
+docs/_build/
 
 # Test log files
 *.log
@@ -0,0 +1,26 @@
+from esp_docs.conf_docs import *  # noqa: F403,F401
+
+languages = ["en"]
+
+# link roles config
+github_repo = "espressif/arduino-esp32"
+
+# context used by sphinx_idf_theme
+html_context["github_user"] = "espressif"
+html_context["github_repo"] = "arduino-esp32"
+
+html_static_path = ["../_static"]
+
+# Conditional content
+
+extensions += ['sphinx_copybutton',
+               'sphinx_tabs.tabs',
+               'esp_docs.esp_extensions.dummy_build_system',
+               ]
+
+ESP32_DOCS = [
+    "index.rst",
+]
+
+# Extra options required by sphinx_idf_theme
+project_slug = "arduino-esp32"
@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+#
+# English Language RTD & Sphinx config file
+#
+# Uses ../conf_common.py for most non-language-specific settings.
+
+# Importing conf_common adds all the non-language-specific
+# parts to this conf module
+
+import datetime
+
+try:
+    from conf_common import *  # noqa: F403,F401
+except ImportError:
+    import os
+    import sys
+
+    sys.path.insert(0, os.path.abspath("../"))
+    from conf_common import *  # noqa: F403,F401
+
+# General information about the project.
+project = "Arduino-ESP32"
+copyright = "2016 - {}, Espressif Systems (Shanghai) Co., Ltd".format(
+    datetime.datetime.now().year
+)
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+language = "en"