espressif · pedrominatel · Aug 4, 2022 · Aug 3, 2022 · Apr 1, 2022 · Apr 1, 2022
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,4 +1,4 @@
-name: ReadTheDocs CI
+name: Docs CI
 
 on:
   push:
@@ -16,7 +16,7 @@ on:
 jobs:
 
   build-docs:
-    name: Build ReadTheDocs
+    name: Build Docs
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -35,4 +35,62 @@ jobs:
         # 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
+        cd ./docs && PATH=/home/runner/.local/bin:$PATH build-docs -l en
+
+  deploy-docs:
+    name: Deploy Docs
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Deploy Production
+      env:
+        DOCS_BUILD_DIR: "./docs/_build/"
+        DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_DEPLOY_KEY }}
+        DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PROD_SERVER }}
+        DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_SERVER_USER }}
+        DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }}
+        DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
+      run: |
+        PATH=/home/runner/.local/bin:$PATH pip install -r ./docs/requirements.txt --prefer-binary
+        PATH=/home/runner/.local/bin:$PATH source ./docs/utils.sh
+        PATH=/home/runner/.local/bin:$PATH add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
+        PATH=/home/runner/.local/bin:$PATH export GIT_VER=$(git describe --always)
+        cd ./docs && PATH=/home/runner/.local/bin:$PATH build-docs -l en
+        PATH=/home/runner/.local/bin:$PATH deploy-docs
+
+  deploy-preview-docs:
+    name: Deploy Preview Docs
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - 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: |
+        PATH=/home/runner/.local/bin:$PATH pip install -r ./docs/requirements.txt --prefer-binary
+        PATH=/home/runner/.local/bin:$PATH source ./docs/utils.sh
+        PATH=/home/runner/.local/bin:$PATH add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
+        PATH=/home/runner/.local/bin:$PATH export GIT_VER=$(git describe --always)
+        cd ./docs && PATH=/home/runner/.local/bin:$PATH build-docs -l en
+        PATH=/home/runner/.local/bin:$PATH deploy-docs
diff --git a/.gitignore b/.gitignore
@@ -23,6 +23,8 @@ boards.sloeber.txt
 # Ignore docs build (Sphinx)
 docs/build
 docs/source/_build
+docs/__pycache__/
+docs/_build/
 
 # Test log files
 *.log
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/source/_static/arduino-ide.png → docs/_static/arduino-ide.png b/docs/source/_static/arduino-ide.png → docs/_static/arduino-ide.png
diff --git a/docs/source/_static/arduino_i2c_master.png → docs/_static/arduino_i2c_master.png b/docs/source/_static/arduino_i2c_master.png → docs/_static/arduino_i2c_master.png
diff --git a/docs/source/_static/arduino_i2c_slave.png → docs/_static/arduino_i2c_slave.png b/docs/source/_static/arduino_i2c_slave.png → docs/_static/arduino_i2c_slave.png
diff --git a/.../_static/esp32-c3_devkitM-1_pinlayout.png → .../_static/esp32-c3_devkitM-1_pinlayout.png b/.../_static/esp32-c3_devkitM-1_pinlayout.png → .../_static/esp32-c3_devkitM-1_pinlayout.png
diff --git a/...rce/_static/esp32-s2_saola1_pinlayout.png → docs/_static/esp32-s2_saola1_pinlayout.png b/...rce/_static/esp32-s2_saola1_pinlayout.png → docs/_static/esp32-s2_saola1_pinlayout.png
diff --git a/...ource/_static/esp32_devkitC_pinlayout.png → docs/_static/esp32_devkitC_pinlayout.png b/...ource/_static/esp32_devkitC_pinlayout.png → docs/_static/esp32_devkitC_pinlayout.png
diff --git a/docs/source/_static/gpio_output.png → docs/_static/gpio_output.png b/docs/source/_static/gpio_output.png → docs/_static/gpio_output.png
diff --git a/docs/source/_static/gpio_pullup.png → docs/_static/gpio_pullup.png b/docs/source/_static/gpio_pullup.png → docs/_static/gpio_pullup.png
diff --git a/...ic/install_guide_boards_manager_esp32.png → ...ic/install_guide_boards_manager_esp32.png b/...ic/install_guide_boards_manager_esp32.png → ...ic/install_guide_boards_manager_esp32.png
diff --git a/...atic/install_guide_boards_manager_url.png → ...atic/install_guide_boards_manager_url.png b/...atic/install_guide_boards_manager_url.png → ...atic/install_guide_boards_manager_url.png
diff --git a/...rce/_static/install_guide_preferences.png → docs/_static/install_guide_preferences.png b/...rce/_static/install_guide_preferences.png → docs/_static/install_guide_preferences.png
diff --git a/docs/source/_static/logo_arduino.png → docs/_static/logo_arduino.png b/docs/source/_static/logo_arduino.png → docs/_static/logo_arduino.png
diff --git a/docs/source/_static/logo_espressif.png → docs/_static/logo_espressif.png b/docs/source/_static/logo_espressif.png → docs/_static/logo_espressif.png
diff --git a/docs/source/_static/logo_linux.png → docs/_static/logo_linux.png b/docs/source/_static/logo_linux.png → docs/_static/logo_linux.png
diff --git a/docs/source/_static/logo_macos.png → docs/_static/logo_macos.png b/docs/source/_static/logo_macos.png → docs/_static/logo_macos.png
diff --git a/docs/source/_static/logo_pio.png → docs/_static/logo_pio.png b/docs/source/_static/logo_pio.png → docs/_static/logo_pio.png
diff --git a/docs/source/_static/logo_windows.png → docs/_static/logo_windows.png b/docs/source/_static/logo_windows.png → docs/_static/logo_windows.png
diff --git a/docs/source/_static/ota_esp32_login.png → docs/_static/ota_esp32_login.png b/docs/source/_static/ota_esp32_login.png → docs/_static/ota_esp32_login.png
diff --git a/docs/source/_static/ota_esp32_upload.png → docs/_static/ota_esp32_upload.png b/docs/source/_static/ota_esp32_upload.png → docs/_static/ota_esp32_upload.png
diff --git a/docs/source/_static/ota_esp32_verbose.png → docs/_static/ota_esp32_verbose.png b/docs/source/_static/ota_esp32_verbose.png → docs/_static/ota_esp32_verbose.png
diff --git a/docs/source/_static/ota_export_to_binary.png → docs/_static/ota_export_to_binary.png b/docs/source/_static/ota_export_to_binary.png → docs/_static/ota_export_to_binary.png
diff --git a/docs/source/_static/soc-module.png → docs/_static/soc-module.png b/docs/source/_static/soc-module.png → docs/_static/soc-module.png
diff --git a/...ic/tutorials/basic/tutorial_basic_ide.png → ...ic/tutorials/basic/tutorial_basic_ide.png b/...ic/tutorials/basic/tutorial_basic_ide.png → ...ic/tutorials/basic/tutorial_basic_ide.png
diff --git a/...ripherals/tutorial_peripheral_diagram.png → ...ripherals/tutorial_peripheral_diagram.png b/...ripherals/tutorial_peripheral_diagram.png → ...ripherals/tutorial_peripheral_diagram.png
diff --git a/docs/source/_static/usb_msc_drive.png → docs/_static/usb_msc_drive.png b/docs/source/_static/usb_msc_drive.png → docs/_static/usb_msc_drive.png
diff --git a/docs/source/_static/wifi_esp32_ap.png → docs/_static/wifi_esp32_ap.png b/docs/source/_static/wifi_esp32_ap.png → docs/_static/wifi_esp32_ap.png
diff --git a/docs/source/_static/wifi_esp32_sta.png → docs/_static/wifi_esp32_sta.png b/docs/source/_static/wifi_esp32_sta.png → docs/_static/wifi_esp32_sta.png
diff --git a/docs/source/_static/win-gui-1.png → docs/_static/win-gui-1.png b/docs/source/_static/win-gui-1.png → docs/_static/win-gui-1.png
diff --git a/docs/source/_static/win-gui-2.png → docs/_static/win-gui-2.png b/docs/source/_static/win-gui-2.png → docs/_static/win-gui-2.png
diff --git a/docs/source/_static/win-gui-3.png → docs/_static/win-gui-3.png b/docs/source/_static/win-gui-3.png → docs/_static/win-gui-3.png
diff --git a/docs/source/_static/win-gui-4.png → docs/_static/win-gui-4.png b/docs/source/_static/win-gui-4.png → docs/_static/win-gui-4.png
diff --git a/docs/source/_static/win-gui-5.png → docs/_static/win-gui-5.png b/docs/source/_static/win-gui-5.png → docs/_static/win-gui-5.png
diff --git a/docs/source/_static/win-gui-update-1.png → docs/_static/win-gui-update-1.png b/docs/source/_static/win-gui-update-1.png → docs/_static/win-gui-update-1.png
diff --git a/docs/source/_static/win-gui-update-2.png → docs/_static/win-gui-update-2.png b/docs/source/_static/win-gui-update-2.png → docs/_static/win-gui-update-2.png
diff --git a/docs/conf_common.py b/docs/conf_common.py
@@ -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"
diff --git a/docs/source/advanced_utils.rst → docs/en/advanced_utils.rst b/docs/source/advanced_utils.rst → docs/en/advanced_utils.rst
diff --git a/docs/source/api/adc.rst → docs/en/api/adc.rst b/docs/source/api/adc.rst → docs/en/api/adc.rst
diff --git a/docs/source/api/bluetooth.rst → docs/en/api/bluetooth.rst b/docs/source/api/bluetooth.rst → docs/en/api/bluetooth.rst
diff --git a/docs/source/api/dac.rst → docs/en/api/dac.rst b/docs/source/api/dac.rst → docs/en/api/dac.rst
diff --git a/docs/source/api/deepsleep.rst → docs/en/api/deepsleep.rst b/docs/source/api/deepsleep.rst → docs/en/api/deepsleep.rst
diff --git a/docs/source/api/espnow.rst → docs/en/api/espnow.rst b/docs/source/api/espnow.rst → docs/en/api/espnow.rst
diff --git a/docs/source/api/gpio.rst → docs/en/api/gpio.rst b/docs/source/api/gpio.rst → docs/en/api/gpio.rst
diff --git a/docs/source/api/i2c.rst → docs/en/api/i2c.rst b/docs/source/api/i2c.rst → docs/en/api/i2c.rst
@@ -19,15 +19,15 @@ The I2C can be used in two different modes:
 * **I2C Master Mode**
     * In this mode, the ESP32 generates the clock signal and initiates the communication with the slave device.
 
-.. figure:: ../_static/arduino_i2c_master.png
+.. figure:: ../../_static/arduino_i2c_master.png
     :align: center
     :width: 720
     :figclass: align-center
 
 * **I2C Slave Mode**
     * The slave mode, the clock is generated by the master device and responds to the master if the destination address is the same as the destination.
 
-.. figure:: ../_static/arduino_i2c_slave.png
+.. figure:: ../../_static/arduino_i2c_slave.png
     :align: center
     :width: 520
     :figclass: align-center

diff --git a/docs/source/api/i2s.rst → docs/en/api/i2s.rst b/docs/source/api/i2s.rst → docs/en/api/i2s.rst
diff --git a/docs/source/api/ledc.rst → docs/en/api/ledc.rst b/docs/source/api/ledc.rst → docs/en/api/ledc.rst
diff --git a/docs/source/api/preferences.rst → docs/en/api/preferences.rst b/docs/source/api/preferences.rst → docs/en/api/preferences.rst
diff --git a/docs/source/api/rainmaker.rst → docs/en/api/rainmaker.rst b/docs/source/api/rainmaker.rst → docs/en/api/rainmaker.rst
diff --git a/docs/source/api/reset_reason.rst → docs/en/api/reset_reason.rst b/docs/source/api/reset_reason.rst → docs/en/api/reset_reason.rst
diff --git a/docs/source/api/sigmadelta.rst → docs/en/api/sigmadelta.rst b/docs/source/api/sigmadelta.rst → docs/en/api/sigmadelta.rst
diff --git a/docs/source/api/timer.rst → docs/en/api/timer.rst b/docs/source/api/timer.rst → docs/en/api/timer.rst
diff --git a/docs/source/api/usb.rst → docs/en/api/usb.rst b/docs/source/api/usb.rst → docs/en/api/usb.rst
diff --git a/docs/source/api/usb_cdc.rst → docs/en/api/usb_cdc.rst b/docs/source/api/usb_cdc.rst → docs/en/api/usb_cdc.rst
diff --git a/docs/source/api/usb_msc.rst → docs/en/api/usb_msc.rst b/docs/source/api/usb_msc.rst → docs/en/api/usb_msc.rst
diff --git a/docs/source/api/wifi.rst → docs/en/api/wifi.rst b/docs/source/api/wifi.rst → docs/en/api/wifi.rst
@@ -21,7 +21,7 @@ Working as AP
 In this mode, the ESP32 is configured as an Access Point (AP) and it's capable of receiving incoming connections from other devices (stations) by providing
 a Wi-Fi network.
 
-.. figure:: ../_static/wifi_esp32_ap.png
+.. figure:: ../../_static/wifi_esp32_ap.png
     :align: center
     :width: 520
     :figclass: align-center
@@ -33,7 +33,7 @@ Working as STA
 
 The STA mode is used to connect the ESP32 to a Wi-Fi network, provided by an Access Point.
 
-.. figure:: ../_static/wifi_esp32_sta.png
+.. figure:: ../../_static/wifi_esp32_sta.png
     :align: center
     :width: 520
     :figclass: align-center

diff --git a/docs/source/boards/ESP32-C3-DevKitM-1.rst → docs/en/boards/ESP32-C3-DevKitM-1.rst b/docs/source/boards/ESP32-C3-DevKitM-1.rst → docs/en/boards/ESP32-C3-DevKitM-1.rst
@@ -88,7 +88,7 @@ No.  Name  Type [1]_   Function
 Pin Layout
 ----------
 
-.. figure:: ../_static/esp32-c3_devkitM-1_pinlayout.png
+.. figure:: ../../_static/esp32-c3_devkitM-1_pinlayout.png
     :align: center
     :width: 600
     :alt: ESP32-C3-DevKitM-1 (click to enlarge)

diff --git a/docs/source/boards/ESP32-DevKitC-1.rst → docs/en/boards/ESP32-DevKitC-1.rst b/docs/source/boards/ESP32-DevKitC-1.rst → docs/en/boards/ESP32-DevKitC-1.rst
@@ -96,7 +96,7 @@ No.  Name  Type   Function
 Pin Layout
 ----------
 
-.. figure:: ../_static/esp32_devkitC_pinlayout.png
+.. figure:: ../../_static/esp32_devkitC_pinlayout.png
     :align: center
     :width: 600
     :alt: ESP32-DevKitC-1 (click to enlarge)

diff --git a/docs/source/boards/ESP32-S2-Saola-1.rst → docs/en/boards/ESP32-S2-Saola-1.rst b/docs/source/boards/ESP32-S2-Saola-1.rst → docs/en/boards/ESP32-S2-Saola-1.rst
@@ -100,7 +100,7 @@ No.  Name  Type   Function
 Pin Layout
 ----------
 
-.. figure:: ../_static/esp32-s2_saola1_pinlayout.png
+.. figure:: ../../_static/esp32-s2_saola1_pinlayout.png
     :align: center
     :width: 600
     :alt: ESP32-S2-Saola-1 (click to enlarge)

diff --git a/docs/source/boards/boards.rst → docs/en/boards/boards.rst b/docs/source/boards/boards.rst → docs/en/boards/boards.rst
@@ -28,7 +28,7 @@ For each family, we have SoC variants with some differentiation. The differences
 The modules use the SoC internally, including the external flash, PSRAM (in some models) and other essential electronic components. Essentially, all
 modules from the same family use the same SoC.
 
-.. figure:: ../_static/soc-module.png
+.. figure:: ../../_static/soc-module.png
     :align: center
     :width: 250
     :alt: ESP32 SoC and Module (click to enlarge)
@@ -58,7 +58,7 @@ Before buying: Keep in mind that for some "must have" features when choosing the
 Espressif
 ---------
 
-.. figure:: ../_static/logo_espressif.png
+.. figure:: ../../_static/logo_espressif.png
     :align: center
     :width: 250
     :alt: Espressif Logo

diff --git a/docs/source/boards/generic.rst → docs/en/boards/generic.rst b/docs/source/boards/generic.rst → docs/en/boards/generic.rst
diff --git a/docs/source/common/datasheet.inc → docs/en/common/datasheet.inc b/docs/source/common/datasheet.inc → docs/en/common/datasheet.inc
diff --git a/docs/en/conf.py b/docs/en/conf.py
@@ -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"
diff --git a/docs/source/contributing.rst → docs/en/contributing.rst b/docs/source/contributing.rst → docs/en/contributing.rst
diff --git a/docs/source/esp-idf_component.rst → docs/en/esp-idf_component.rst b/docs/source/esp-idf_component.rst → docs/en/esp-idf_component.rst
diff --git a/docs/source/faq.rst → docs/en/faq.rst b/docs/source/faq.rst → docs/en/faq.rst
diff --git a/docs/source/getting_started.rst → docs/en/getting_started.rst b/docs/source/getting_started.rst → docs/en/getting_started.rst
@@ -62,9 +62,9 @@ Supported Operating Systems
 | Windows           | Linux             | macOS             |
 +-------------------+-------------------+-------------------+
 
-.. |windows-logo| image:: _static/logo_windows.png
-.. |linux-logo| image:: _static/logo_linux.png
-.. |macos-logo| image:: _static/logo_macos.png
+.. |windows-logo| image:: ../_static/logo_windows.png
+.. |linux-logo| image:: ../_static/logo_linux.png
+.. |macos-logo| image:: ../_static/logo_macos.png
 
 Supported IDEs
 ---------------------------
@@ -77,8 +77,8 @@ Here is the list of supported IDE for Arduino ESP32 support integration.
 | Arduino IDE       | PlatformIO        |
 +-------------------+-------------------+
 
-.. |arduino-logo| image:: _static/logo_arduino.png
-.. |pio-logo| image:: _static/logo_pio.png
+.. |arduino-logo| image:: ../_static/logo_arduino.png
+.. |pio-logo| image:: ../_static/logo_pio.png
 
 See `Installing Guides <installing.html>`_ for more details on how to install the Arduino ESP32 support.
 

diff --git a/docs/source/guides/docs_contributing.rst → docs/en/guides/docs_contributing.rst b/docs/source/guides/docs_contributing.rst → docs/en/guides/docs_contributing.rst
@@ -309,7 +309,7 @@ After that, you can use the following structure to include the image in the docs
 
 .. code-block::
 
-    .. figure:: ../_static/arduino_i2c_master.png
+    .. figure:: ../../_static/arduino_i2c_master.png
         :align: center
         :width: 720
         :figclass: align-center

diff --git a/docs/source/guides/guides.rst → docs/en/guides/guides.rst b/docs/source/guides/guides.rst → docs/en/guides/guides.rst
diff --git a/docs/source/guides/tools_menu.rst → docs/en/guides/tools_menu.rst b/docs/source/guides/tools_menu.rst → docs/en/guides/tools_menu.rst
@@ -232,7 +232,7 @@ The USB Mass Storage Class, or USB MSC, is a class used for storage devices, lik
 This option can be used to ``Enable`` or ``Disable`` this function at the boot. If this option is ``Enabled``, once the device is connected via USB, one new storage device will appear in the system as a storage drive.
 Use this new storage drive to write and read files or to drop a new firmware binary to flash the device.
 
-.. figure:: ../_static/usb_msc_drive.png
+.. figure:: ../../_static/usb_msc_drive.png
     :align: center
     :width: 720
     :figclass: align-center

diff --git a/docs/source/index.rst → docs/en/index.rst b/docs/source/index.rst → docs/en/index.rst
@@ -9,7 +9,6 @@ Here you will find all the relevant information about the project.
 
 .. toctree::
    :maxdepth: 1
-   :caption: Contents:
 
    Getting Started <getting_started>
    Libraries <libraries>