diff --git a/docs/COPYRIGHT.rst b/docs/en/COPYRIGHT.rst similarity index 100% rename from docs/COPYRIGHT.rst rename to docs/en/COPYRIGHT.rst diff --git a/docs/Makefile b/docs/en/Makefile similarity index 100% rename from docs/Makefile rename to docs/en/Makefile diff --git a/docs/about.rst b/docs/en/about.rst similarity index 100% rename from docs/about.rst rename to docs/en/about.rst diff --git a/docs/api-guides/SYSVIEW_FreeRTOS.txt b/docs/en/api-guides/SYSVIEW_FreeRTOS.txt similarity index 100% rename from docs/api-guides/SYSVIEW_FreeRTOS.txt rename to docs/en/api-guides/SYSVIEW_FreeRTOS.txt diff --git a/docs/api-guides/app_trace.rst b/docs/en/api-guides/app_trace.rst similarity index 100% rename from docs/api-guides/app_trace.rst rename to docs/en/api-guides/app_trace.rst diff --git a/docs/api-guides/build-system.rst b/docs/en/api-guides/build-system.rst similarity index 100% rename from docs/api-guides/build-system.rst rename to docs/en/api-guides/build-system.rst diff --git a/docs/api-guides/console.rst b/docs/en/api-guides/console.rst similarity index 100% rename from docs/api-guides/console.rst rename to docs/en/api-guides/console.rst diff --git a/docs/api-guides/core_dump.rst b/docs/en/api-guides/core_dump.rst similarity index 100% rename from docs/api-guides/core_dump.rst rename to docs/en/api-guides/core_dump.rst diff --git a/docs/api-guides/deep-sleep-stub.rst b/docs/en/api-guides/deep-sleep-stub.rst similarity index 100% rename from docs/api-guides/deep-sleep-stub.rst rename to docs/en/api-guides/deep-sleep-stub.rst diff --git a/docs/api-guides/external-ram.rst b/docs/en/api-guides/external-ram.rst similarity index 100% rename from docs/api-guides/external-ram.rst rename to docs/en/api-guides/external-ram.rst diff --git a/docs/api-guides/freertos-smp.rst b/docs/en/api-guides/freertos-smp.rst similarity index 100% rename from docs/api-guides/freertos-smp.rst rename to docs/en/api-guides/freertos-smp.rst diff --git a/docs/api-guides/general-notes.rst b/docs/en/api-guides/general-notes.rst similarity index 100% rename from docs/api-guides/general-notes.rst rename to docs/en/api-guides/general-notes.rst diff --git a/docs/api-guides/hlinterrupts.rst b/docs/en/api-guides/hlinterrupts.rst similarity index 100% rename from docs/api-guides/hlinterrupts.rst rename to docs/en/api-guides/hlinterrupts.rst diff --git a/docs/api-guides/index.rst b/docs/en/api-guides/index.rst similarity index 100% rename from docs/api-guides/index.rst rename to docs/en/api-guides/index.rst diff --git a/docs/api-guides/jtag-debugging/building-openocd-linux.rst b/docs/en/api-guides/jtag-debugging/building-openocd-linux.rst similarity index 100% rename from docs/api-guides/jtag-debugging/building-openocd-linux.rst rename to docs/en/api-guides/jtag-debugging/building-openocd-linux.rst diff --git a/docs/api-guides/jtag-debugging/building-openocd-macos.rst b/docs/en/api-guides/jtag-debugging/building-openocd-macos.rst similarity index 100% rename from docs/api-guides/jtag-debugging/building-openocd-macos.rst rename to docs/en/api-guides/jtag-debugging/building-openocd-macos.rst diff --git a/docs/api-guides/jtag-debugging/building-openocd-windows.rst b/docs/en/api-guides/jtag-debugging/building-openocd-windows.rst similarity index 100% rename from docs/api-guides/jtag-debugging/building-openocd-windows.rst rename to docs/en/api-guides/jtag-debugging/building-openocd-windows.rst diff --git a/docs/api-guides/jtag-debugging/configure-other-jtag.rst b/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst similarity index 100% rename from docs/api-guides/jtag-debugging/configure-other-jtag.rst rename to docs/en/api-guides/jtag-debugging/configure-other-jtag.rst diff --git a/docs/api-guides/jtag-debugging/configure-wrover.rst b/docs/en/api-guides/jtag-debugging/configure-wrover.rst similarity index 100% rename from docs/api-guides/jtag-debugging/configure-wrover.rst rename to docs/en/api-guides/jtag-debugging/configure-wrover.rst diff --git a/docs/api-guides/jtag-debugging/debugging-examples.rst b/docs/en/api-guides/jtag-debugging/debugging-examples.rst similarity index 100% rename from docs/api-guides/jtag-debugging/debugging-examples.rst rename to docs/en/api-guides/jtag-debugging/debugging-examples.rst diff --git a/docs/api-guides/jtag-debugging/index.rst b/docs/en/api-guides/jtag-debugging/index.rst similarity index 100% rename from docs/api-guides/jtag-debugging/index.rst rename to docs/en/api-guides/jtag-debugging/index.rst diff --git a/docs/api-guides/jtag-debugging/setup-openocd-linux.rst b/docs/en/api-guides/jtag-debugging/setup-openocd-linux.rst similarity index 100% rename from docs/api-guides/jtag-debugging/setup-openocd-linux.rst rename to docs/en/api-guides/jtag-debugging/setup-openocd-linux.rst diff --git a/docs/api-guides/jtag-debugging/setup-openocd-macos.rst b/docs/en/api-guides/jtag-debugging/setup-openocd-macos.rst similarity index 100% rename from docs/api-guides/jtag-debugging/setup-openocd-macos.rst rename to docs/en/api-guides/jtag-debugging/setup-openocd-macos.rst diff --git a/docs/api-guides/jtag-debugging/setup-openocd-windows.rst b/docs/en/api-guides/jtag-debugging/setup-openocd-windows.rst similarity index 100% rename from docs/api-guides/jtag-debugging/setup-openocd-windows.rst rename to docs/en/api-guides/jtag-debugging/setup-openocd-windows.rst diff --git a/docs/api-guides/jtag-debugging/tips-and-quirks.rst b/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst similarity index 100% rename from docs/api-guides/jtag-debugging/tips-and-quirks.rst rename to docs/en/api-guides/jtag-debugging/tips-and-quirks.rst diff --git a/docs/api-guides/jtag-debugging/using-debugger.rst b/docs/en/api-guides/jtag-debugging/using-debugger.rst similarity index 100% rename from docs/api-guides/jtag-debugging/using-debugger.rst rename to docs/en/api-guides/jtag-debugging/using-debugger.rst diff --git a/docs/api-guides/partition-tables.rst b/docs/en/api-guides/partition-tables.rst similarity index 100% rename from docs/api-guides/partition-tables.rst rename to docs/en/api-guides/partition-tables.rst diff --git a/docs/api-guides/romconsole.rst b/docs/en/api-guides/romconsole.rst similarity index 100% rename from docs/api-guides/romconsole.rst rename to docs/en/api-guides/romconsole.rst diff --git a/docs/api-guides/ulp.rst b/docs/en/api-guides/ulp.rst similarity index 100% rename from docs/api-guides/ulp.rst rename to docs/en/api-guides/ulp.rst diff --git a/docs/api-guides/ulp_instruction_set.rst b/docs/en/api-guides/ulp_instruction_set.rst similarity index 100% rename from docs/api-guides/ulp_instruction_set.rst rename to docs/en/api-guides/ulp_instruction_set.rst diff --git a/docs/api-guides/ulp_macros.rst b/docs/en/api-guides/ulp_macros.rst similarity index 100% rename from docs/api-guides/ulp_macros.rst rename to docs/en/api-guides/ulp_macros.rst diff --git a/docs/api-guides/unit-tests.rst b/docs/en/api-guides/unit-tests.rst similarity index 100% rename from docs/api-guides/unit-tests.rst rename to docs/en/api-guides/unit-tests.rst diff --git a/docs/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst similarity index 100% rename from docs/api-guides/wifi.rst rename to docs/en/api-guides/wifi.rst diff --git a/docs/api-reference/bluetooth/bt_common.rst b/docs/en/api-reference/bluetooth/bt_common.rst similarity index 100% rename from docs/api-reference/bluetooth/bt_common.rst rename to docs/en/api-reference/bluetooth/bt_common.rst diff --git a/docs/api-reference/bluetooth/bt_le.rst b/docs/en/api-reference/bluetooth/bt_le.rst similarity index 100% rename from docs/api-reference/bluetooth/bt_le.rst rename to docs/en/api-reference/bluetooth/bt_le.rst diff --git a/docs/api-reference/bluetooth/classic_bt.rst b/docs/en/api-reference/bluetooth/classic_bt.rst similarity index 100% rename from docs/api-reference/bluetooth/classic_bt.rst rename to docs/en/api-reference/bluetooth/classic_bt.rst diff --git a/docs/api-reference/bluetooth/controller_vhci.rst b/docs/en/api-reference/bluetooth/controller_vhci.rst similarity index 100% rename from docs/api-reference/bluetooth/controller_vhci.rst rename to docs/en/api-reference/bluetooth/controller_vhci.rst diff --git a/docs/api-reference/bluetooth/esp_a2dp.rst b/docs/en/api-reference/bluetooth/esp_a2dp.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_a2dp.rst rename to docs/en/api-reference/bluetooth/esp_a2dp.rst diff --git a/docs/api-reference/bluetooth/esp_avrc.rst b/docs/en/api-reference/bluetooth/esp_avrc.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_avrc.rst rename to docs/en/api-reference/bluetooth/esp_avrc.rst diff --git a/docs/api-reference/bluetooth/esp_blufi.rst b/docs/en/api-reference/bluetooth/esp_blufi.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_blufi.rst rename to docs/en/api-reference/bluetooth/esp_blufi.rst diff --git a/docs/api-reference/bluetooth/esp_bt_defs.rst b/docs/en/api-reference/bluetooth/esp_bt_defs.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_bt_defs.rst rename to docs/en/api-reference/bluetooth/esp_bt_defs.rst diff --git a/docs/api-reference/bluetooth/esp_bt_device.rst b/docs/en/api-reference/bluetooth/esp_bt_device.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_bt_device.rst rename to docs/en/api-reference/bluetooth/esp_bt_device.rst diff --git a/docs/api-reference/bluetooth/esp_bt_main.rst b/docs/en/api-reference/bluetooth/esp_bt_main.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_bt_main.rst rename to docs/en/api-reference/bluetooth/esp_bt_main.rst diff --git a/docs/api-reference/bluetooth/esp_gap_ble.rst b/docs/en/api-reference/bluetooth/esp_gap_ble.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_gap_ble.rst rename to docs/en/api-reference/bluetooth/esp_gap_ble.rst diff --git a/docs/api-reference/bluetooth/esp_gap_bt.rst b/docs/en/api-reference/bluetooth/esp_gap_bt.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_gap_bt.rst rename to docs/en/api-reference/bluetooth/esp_gap_bt.rst diff --git a/docs/api-reference/bluetooth/esp_gatt_defs.rst b/docs/en/api-reference/bluetooth/esp_gatt_defs.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_gatt_defs.rst rename to docs/en/api-reference/bluetooth/esp_gatt_defs.rst diff --git a/docs/api-reference/bluetooth/esp_gattc.rst b/docs/en/api-reference/bluetooth/esp_gattc.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_gattc.rst rename to docs/en/api-reference/bluetooth/esp_gattc.rst diff --git a/docs/api-reference/bluetooth/esp_gatts.rst b/docs/en/api-reference/bluetooth/esp_gatts.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_gatts.rst rename to docs/en/api-reference/bluetooth/esp_gatts.rst diff --git a/docs/api-reference/bluetooth/esp_spp.rst b/docs/en/api-reference/bluetooth/esp_spp.rst similarity index 100% rename from docs/api-reference/bluetooth/esp_spp.rst rename to docs/en/api-reference/bluetooth/esp_spp.rst diff --git a/docs/api-reference/bluetooth/index.rst b/docs/en/api-reference/bluetooth/index.rst similarity index 100% rename from docs/api-reference/bluetooth/index.rst rename to docs/en/api-reference/bluetooth/index.rst diff --git a/docs/api-reference/ethernet/esp_eth.rst b/docs/en/api-reference/ethernet/esp_eth.rst similarity index 100% rename from docs/api-reference/ethernet/esp_eth.rst rename to docs/en/api-reference/ethernet/esp_eth.rst diff --git a/docs/api-reference/ethernet/index.rst b/docs/en/api-reference/ethernet/index.rst similarity index 100% rename from docs/api-reference/ethernet/index.rst rename to docs/en/api-reference/ethernet/index.rst diff --git a/docs/api-reference/index.rst b/docs/en/api-reference/index.rst similarity index 100% rename from docs/api-reference/index.rst rename to docs/en/api-reference/index.rst diff --git a/docs/api-reference/kconfig.rst b/docs/en/api-reference/kconfig.rst similarity index 100% rename from docs/api-reference/kconfig.rst rename to docs/en/api-reference/kconfig.rst diff --git a/docs/api-reference/peripherals/adc.rst b/docs/en/api-reference/peripherals/adc.rst similarity index 100% rename from docs/api-reference/peripherals/adc.rst rename to docs/en/api-reference/peripherals/adc.rst diff --git a/docs/api-reference/peripherals/dac.rst b/docs/en/api-reference/peripherals/dac.rst similarity index 100% rename from docs/api-reference/peripherals/dac.rst rename to docs/en/api-reference/peripherals/dac.rst diff --git a/docs/api-reference/peripherals/gpio.rst b/docs/en/api-reference/peripherals/gpio.rst similarity index 100% rename from docs/api-reference/peripherals/gpio.rst rename to docs/en/api-reference/peripherals/gpio.rst diff --git a/docs/api-reference/peripherals/i2c.rst b/docs/en/api-reference/peripherals/i2c.rst similarity index 100% rename from docs/api-reference/peripherals/i2c.rst rename to docs/en/api-reference/peripherals/i2c.rst diff --git a/docs/api-reference/peripherals/i2s.rst b/docs/en/api-reference/peripherals/i2s.rst similarity index 100% rename from docs/api-reference/peripherals/i2s.rst rename to docs/en/api-reference/peripherals/i2s.rst diff --git a/docs/api-reference/peripherals/index.rst b/docs/en/api-reference/peripherals/index.rst similarity index 100% rename from docs/api-reference/peripherals/index.rst rename to docs/en/api-reference/peripherals/index.rst diff --git a/docs/api-reference/peripherals/ledc.rst b/docs/en/api-reference/peripherals/ledc.rst similarity index 100% rename from docs/api-reference/peripherals/ledc.rst rename to docs/en/api-reference/peripherals/ledc.rst diff --git a/docs/api-reference/peripherals/mcpwm.rst b/docs/en/api-reference/peripherals/mcpwm.rst similarity index 100% rename from docs/api-reference/peripherals/mcpwm.rst rename to docs/en/api-reference/peripherals/mcpwm.rst diff --git a/docs/api-reference/peripherals/pcnt.rst b/docs/en/api-reference/peripherals/pcnt.rst similarity index 100% rename from docs/api-reference/peripherals/pcnt.rst rename to docs/en/api-reference/peripherals/pcnt.rst diff --git a/docs/api-reference/peripherals/rmt.rst b/docs/en/api-reference/peripherals/rmt.rst similarity index 100% rename from docs/api-reference/peripherals/rmt.rst rename to docs/en/api-reference/peripherals/rmt.rst diff --git a/docs/api-reference/peripherals/sigmadelta.rst b/docs/en/api-reference/peripherals/sigmadelta.rst similarity index 100% rename from docs/api-reference/peripherals/sigmadelta.rst rename to docs/en/api-reference/peripherals/sigmadelta.rst diff --git a/docs/api-reference/peripherals/spi_master.rst b/docs/en/api-reference/peripherals/spi_master.rst similarity index 100% rename from docs/api-reference/peripherals/spi_master.rst rename to docs/en/api-reference/peripherals/spi_master.rst diff --git a/docs/api-reference/peripherals/spi_slave.rst b/docs/en/api-reference/peripherals/spi_slave.rst similarity index 100% rename from docs/api-reference/peripherals/spi_slave.rst rename to docs/en/api-reference/peripherals/spi_slave.rst diff --git a/docs/api-reference/peripherals/timer.rst b/docs/en/api-reference/peripherals/timer.rst similarity index 100% rename from docs/api-reference/peripherals/timer.rst rename to docs/en/api-reference/peripherals/timer.rst diff --git a/docs/api-reference/peripherals/touch_pad.rst b/docs/en/api-reference/peripherals/touch_pad.rst similarity index 100% rename from docs/api-reference/peripherals/touch_pad.rst rename to docs/en/api-reference/peripherals/touch_pad.rst diff --git a/docs/api-reference/peripherals/uart.rst b/docs/en/api-reference/peripherals/uart.rst similarity index 100% rename from docs/api-reference/peripherals/uart.rst rename to docs/en/api-reference/peripherals/uart.rst diff --git a/docs/api-reference/protocols/index.rst b/docs/en/api-reference/protocols/index.rst similarity index 100% rename from docs/api-reference/protocols/index.rst rename to docs/en/api-reference/protocols/index.rst diff --git a/docs/api-reference/protocols/mdns.rst b/docs/en/api-reference/protocols/mdns.rst similarity index 100% rename from docs/api-reference/protocols/mdns.rst rename to docs/en/api-reference/protocols/mdns.rst diff --git a/docs/api-reference/storage/fatfs.rst b/docs/en/api-reference/storage/fatfs.rst similarity index 100% rename from docs/api-reference/storage/fatfs.rst rename to docs/en/api-reference/storage/fatfs.rst diff --git a/docs/api-reference/storage/index.rst b/docs/en/api-reference/storage/index.rst similarity index 100% rename from docs/api-reference/storage/index.rst rename to docs/en/api-reference/storage/index.rst diff --git a/docs/api-reference/storage/nvs_flash.rst b/docs/en/api-reference/storage/nvs_flash.rst similarity index 100% rename from docs/api-reference/storage/nvs_flash.rst rename to docs/en/api-reference/storage/nvs_flash.rst diff --git a/docs/api-reference/storage/sdmmc.rst b/docs/en/api-reference/storage/sdmmc.rst similarity index 100% rename from docs/api-reference/storage/sdmmc.rst rename to docs/en/api-reference/storage/sdmmc.rst diff --git a/docs/api-reference/storage/spi_flash.rst b/docs/en/api-reference/storage/spi_flash.rst similarity index 100% rename from docs/api-reference/storage/spi_flash.rst rename to docs/en/api-reference/storage/spi_flash.rst diff --git a/docs/api-reference/storage/spiffs.rst b/docs/en/api-reference/storage/spiffs.rst similarity index 100% rename from docs/api-reference/storage/spiffs.rst rename to docs/en/api-reference/storage/spiffs.rst diff --git a/docs/api-reference/storage/vfs.rst b/docs/en/api-reference/storage/vfs.rst similarity index 100% rename from docs/api-reference/storage/vfs.rst rename to docs/en/api-reference/storage/vfs.rst diff --git a/docs/api-reference/storage/wear-levelling.rst b/docs/en/api-reference/storage/wear-levelling.rst similarity index 100% rename from docs/api-reference/storage/wear-levelling.rst rename to docs/en/api-reference/storage/wear-levelling.rst diff --git a/docs/api-reference/system/app_trace.rst b/docs/en/api-reference/system/app_trace.rst similarity index 100% rename from docs/api-reference/system/app_trace.rst rename to docs/en/api-reference/system/app_trace.rst diff --git a/docs/api-reference/system/base_mac_address.rst b/docs/en/api-reference/system/base_mac_address.rst similarity index 100% rename from docs/api-reference/system/base_mac_address.rst rename to docs/en/api-reference/system/base_mac_address.rst diff --git a/docs/api-reference/system/esp_timer.rst b/docs/en/api-reference/system/esp_timer.rst similarity index 100% rename from docs/api-reference/system/esp_timer.rst rename to docs/en/api-reference/system/esp_timer.rst diff --git a/docs/api-reference/system/freertos.rst b/docs/en/api-reference/system/freertos.rst similarity index 100% rename from docs/api-reference/system/freertos.rst rename to docs/en/api-reference/system/freertos.rst diff --git a/docs/api-reference/system/heap_debug.rst b/docs/en/api-reference/system/heap_debug.rst similarity index 100% rename from docs/api-reference/system/heap_debug.rst rename to docs/en/api-reference/system/heap_debug.rst diff --git a/docs/api-reference/system/hooks.rst b/docs/en/api-reference/system/hooks.rst similarity index 100% rename from docs/api-reference/system/hooks.rst rename to docs/en/api-reference/system/hooks.rst diff --git a/docs/api-reference/system/index.rst b/docs/en/api-reference/system/index.rst similarity index 100% rename from docs/api-reference/system/index.rst rename to docs/en/api-reference/system/index.rst diff --git a/docs/api-reference/system/intr_alloc.rst b/docs/en/api-reference/system/intr_alloc.rst similarity index 100% rename from docs/api-reference/system/intr_alloc.rst rename to docs/en/api-reference/system/intr_alloc.rst diff --git a/docs/api-reference/system/ipc.rst b/docs/en/api-reference/system/ipc.rst similarity index 100% rename from docs/api-reference/system/ipc.rst rename to docs/en/api-reference/system/ipc.rst diff --git a/docs/api-reference/system/log.rst b/docs/en/api-reference/system/log.rst similarity index 100% rename from docs/api-reference/system/log.rst rename to docs/en/api-reference/system/log.rst diff --git a/docs/api-reference/system/mem_alloc.rst b/docs/en/api-reference/system/mem_alloc.rst similarity index 100% rename from docs/api-reference/system/mem_alloc.rst rename to docs/en/api-reference/system/mem_alloc.rst diff --git a/docs/api-reference/system/ota.rst b/docs/en/api-reference/system/ota.rst similarity index 100% rename from docs/api-reference/system/ota.rst rename to docs/en/api-reference/system/ota.rst diff --git a/docs/api-reference/system/power_management.rst b/docs/en/api-reference/system/power_management.rst similarity index 100% rename from docs/api-reference/system/power_management.rst rename to docs/en/api-reference/system/power_management.rst diff --git a/docs/api-reference/system/sleep_modes.rst b/docs/en/api-reference/system/sleep_modes.rst similarity index 100% rename from docs/api-reference/system/sleep_modes.rst rename to docs/en/api-reference/system/sleep_modes.rst diff --git a/docs/api-reference/system/wdts.rst b/docs/en/api-reference/system/wdts.rst similarity index 100% rename from docs/api-reference/system/wdts.rst rename to docs/en/api-reference/system/wdts.rst diff --git a/docs/api-reference/template.rst b/docs/en/api-reference/template.rst similarity index 100% rename from docs/api-reference/template.rst rename to docs/en/api-reference/template.rst diff --git a/docs/api-reference/wifi/esp_now.rst b/docs/en/api-reference/wifi/esp_now.rst similarity index 100% rename from docs/api-reference/wifi/esp_now.rst rename to docs/en/api-reference/wifi/esp_now.rst diff --git a/docs/api-reference/wifi/esp_smartconfig.rst b/docs/en/api-reference/wifi/esp_smartconfig.rst similarity index 100% rename from docs/api-reference/wifi/esp_smartconfig.rst rename to docs/en/api-reference/wifi/esp_smartconfig.rst diff --git a/docs/api-reference/wifi/esp_wifi.rst b/docs/en/api-reference/wifi/esp_wifi.rst similarity index 100% rename from docs/api-reference/wifi/esp_wifi.rst rename to docs/en/api-reference/wifi/esp_wifi.rst diff --git a/docs/api-reference/wifi/index.rst b/docs/en/api-reference/wifi/index.rst similarity index 100% rename from docs/api-reference/wifi/index.rst rename to docs/en/api-reference/wifi/index.rst diff --git a/docs/conf.py b/docs/en/conf.py similarity index 100% rename from docs/conf.py rename to docs/en/conf.py diff --git a/docs/contribute/contributor-agreement.rst b/docs/en/contribute/contributor-agreement.rst similarity index 100% rename from docs/contribute/contributor-agreement.rst rename to docs/en/contribute/contributor-agreement.rst diff --git a/docs/contribute/documenting-code.rst b/docs/en/contribute/documenting-code.rst similarity index 100% rename from docs/contribute/documenting-code.rst rename to docs/en/contribute/documenting-code.rst diff --git a/docs/contribute/index.rst b/docs/en/contribute/index.rst similarity index 100% rename from docs/contribute/index.rst rename to docs/en/contribute/index.rst diff --git a/docs/contribute/style-guide.rst b/docs/en/contribute/style-guide.rst similarity index 100% rename from docs/contribute/style-guide.rst rename to docs/en/contribute/style-guide.rst diff --git a/docs/get-started/add-idf_path-to-profile.rst b/docs/en/get-started/add-idf_path-to-profile.rst similarity index 100% rename from docs/get-started/add-idf_path-to-profile.rst rename to docs/en/get-started/add-idf_path-to-profile.rst diff --git a/docs/get-started/eclipse-setup-windows.rst b/docs/en/get-started/eclipse-setup-windows.rst similarity index 100% rename from docs/get-started/eclipse-setup-windows.rst rename to docs/en/get-started/eclipse-setup-windows.rst diff --git a/docs/get-started/eclipse-setup.rst b/docs/en/get-started/eclipse-setup.rst similarity index 100% rename from docs/get-started/eclipse-setup.rst rename to docs/en/get-started/eclipse-setup.rst diff --git a/docs/get-started/establish-serial-connection.rst b/docs/en/get-started/establish-serial-connection.rst similarity index 100% rename from docs/get-started/establish-serial-connection.rst rename to docs/en/get-started/establish-serial-connection.rst diff --git a/docs/get-started/get-started-devkitc-v2.rst b/docs/en/get-started/get-started-devkitc-v2.rst similarity index 100% rename from docs/get-started/get-started-devkitc-v2.rst rename to docs/en/get-started/get-started-devkitc-v2.rst diff --git a/docs/get-started/get-started-devkitc.rst b/docs/en/get-started/get-started-devkitc.rst similarity index 100% rename from docs/get-started/get-started-devkitc.rst rename to docs/en/get-started/get-started-devkitc.rst diff --git a/docs/get-started/get-started-pico-kit-v3.rst b/docs/en/get-started/get-started-pico-kit-v3.rst similarity index 100% rename from docs/get-started/get-started-pico-kit-v3.rst rename to docs/en/get-started/get-started-pico-kit-v3.rst diff --git a/docs/get-started/get-started-pico-kit.rst b/docs/en/get-started/get-started-pico-kit.rst similarity index 100% rename from docs/get-started/get-started-pico-kit.rst rename to docs/en/get-started/get-started-pico-kit.rst diff --git a/docs/get-started/get-started-wrover-kit-v2.rst b/docs/en/get-started/get-started-wrover-kit-v2.rst similarity index 100% rename from docs/get-started/get-started-wrover-kit-v2.rst rename to docs/en/get-started/get-started-wrover-kit-v2.rst diff --git a/docs/get-started/get-started-wrover-kit.rst b/docs/en/get-started/get-started-wrover-kit.rst similarity index 100% rename from docs/get-started/get-started-wrover-kit.rst rename to docs/en/get-started/get-started-wrover-kit.rst diff --git a/docs/get-started/idf-monitor.rst b/docs/en/get-started/idf-monitor.rst similarity index 100% rename from docs/get-started/idf-monitor.rst rename to docs/en/get-started/idf-monitor.rst diff --git a/docs/get-started/index.rst b/docs/en/get-started/index.rst similarity index 100% rename from docs/get-started/index.rst rename to docs/en/get-started/index.rst diff --git a/docs/get-started/linux-setup-scratch.rst b/docs/en/get-started/linux-setup-scratch.rst similarity index 100% rename from docs/get-started/linux-setup-scratch.rst rename to docs/en/get-started/linux-setup-scratch.rst diff --git a/docs/get-started/linux-setup.rst b/docs/en/get-started/linux-setup.rst similarity index 100% rename from docs/get-started/linux-setup.rst rename to docs/en/get-started/linux-setup.rst diff --git a/docs/get-started/macos-setup-scratch.rst b/docs/en/get-started/macos-setup-scratch.rst similarity index 100% rename from docs/get-started/macos-setup-scratch.rst rename to docs/en/get-started/macos-setup-scratch.rst diff --git a/docs/get-started/macos-setup.rst b/docs/en/get-started/macos-setup.rst similarity index 100% rename from docs/get-started/macos-setup.rst rename to docs/en/get-started/macos-setup.rst diff --git a/docs/get-started/make-project.rst b/docs/en/get-started/make-project.rst similarity index 100% rename from docs/get-started/make-project.rst rename to docs/en/get-started/make-project.rst diff --git a/docs/get-started/toolchain-setup-scratch.rst b/docs/en/get-started/toolchain-setup-scratch.rst similarity index 100% rename from docs/get-started/toolchain-setup-scratch.rst rename to docs/en/get-started/toolchain-setup-scratch.rst diff --git a/docs/get-started/windows-setup-scratch.rst b/docs/en/get-started/windows-setup-scratch.rst similarity index 100% rename from docs/get-started/windows-setup-scratch.rst rename to docs/en/get-started/windows-setup-scratch.rst diff --git a/docs/get-started/windows-setup.rst b/docs/en/get-started/windows-setup.rst similarity index 100% rename from docs/get-started/windows-setup.rst rename to docs/en/get-started/windows-setup.rst diff --git a/docs/hw-reference/index.rst b/docs/en/hw-reference/index.rst similarity index 100% rename from docs/hw-reference/index.rst rename to docs/en/hw-reference/index.rst diff --git a/docs/hw-reference/modules-and-boards-previous.rst b/docs/en/hw-reference/modules-and-boards-previous.rst similarity index 100% rename from docs/hw-reference/modules-and-boards-previous.rst rename to docs/en/hw-reference/modules-and-boards-previous.rst diff --git a/docs/hw-reference/modules-and-boards.rst b/docs/en/hw-reference/modules-and-boards.rst similarity index 100% rename from docs/hw-reference/modules-and-boards.rst rename to docs/en/hw-reference/modules-and-boards.rst diff --git a/docs/index.rst b/docs/en/index.rst similarity index 100% rename from docs/index.rst rename to docs/en/index.rst diff --git a/docs/resources.rst b/docs/en/resources.rst similarity index 100% rename from docs/resources.rst rename to docs/en/resources.rst diff --git a/docs/security/flash-encryption.rst b/docs/en/security/flash-encryption.rst similarity index 100% rename from docs/security/flash-encryption.rst rename to docs/en/security/flash-encryption.rst diff --git a/docs/security/secure-boot.rst b/docs/en/security/secure-boot.rst similarity index 100% rename from docs/security/secure-boot.rst rename to docs/en/security/secure-boot.rst diff --git a/docs/get-started/index-cn.rst b/docs/get-started/index-cn.rst deleted file mode 100644 index 5d2a21da30..0000000000 --- a/docs/get-started/index-cn.rst +++ /dev/null @@ -1,324 +0,0 @@ -*********** -快速入门 -*********** - -本文档旨在指导用户创建 ESP32 的软件环境。本文将通过一个简单的例子来说明如何使用 ESP-IDF (Espressif IoT Development Framework)，包括配置、编译、下载固件到开发板等步骤。 - -概述 -====== - -ESP32 是一套 Wi-Fi (2.4 GHz) 和蓝牙 (4.2) 双模解决方案，集成了高性能的 CPU 内核、超低功耗协处理器和丰富的外设。ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用和不同功耗需求。 - -乐鑫为用户提供完整的软、硬件资源进行 ESP32 设备的开发。乐鑫所研发的软件开发环境 ESP-IDF 能够帮助用户快速开发物联网 (IoT) 应用，满足用户对于 Wi-Fi、蓝牙、低功耗等性能的需求。 - -准备工作 -========= - -开发 ESP32 应用程序需要准备： - - -* **电脑**：安装 Windows、Linux 或者 Mac 操作系统 -* **工具链**：用于编译 ESP32 **应用程序** -* **ESP-IDF**：包含 ESP32 API 和用于操作 **工具链** 的脚本 -* **文本编辑器**：编写 C 语言程序，例如 `Eclipse `_ -* **ESP32 开发板** 和将其连接到 **电脑** 的 **USB 线** - -.. figure:: ../_static/what-you-need.png - :align: center - :alt: Development of applications for ESP32 - :figclass: align-center - - 开发应用程序 - -开发环境的准备工作包括以下三部分： - -1. 设置 **工具链** -2. 从 GitHub 上获取 **ESP-IDF** -3. 安装和配置 **Eclipse** - -如果你偏好使用其它编辑器，可以跳过最后一步。 - -环境设置好后，就可以开始开发应用程序了。整个过程可以概括为如下四步： - -1. 配置 **工程** 并编写代码 -2. 编译 **工程** 并链接成一个 **应用程序** -3. 烧写 **应用程序** 到 **ESP32** -4. 监视/调试 **应用程序** - -下文将全程指导你操作完成这些步骤。 - -开发板指南 -========== - -如果你有下列任一 ESP32 开发板，请点击对应的链接，对照指南进行操作就可以让你的板子跑起来。 - -.. toctree:: - :maxdepth: 1 - - ESP32 DevKitC <../get-started/get-started-devkitc> - ESP-WROVER-KIT <../get-started/get-started-wrover-kit> - ESP32-PICO-KIT <../get-started/get-started-pico-kit> - -如果你使用其它开发板，请查看下面的内容。 - -.. _get-started-setup-toolchain-cn: - -设置工具链 -=============== - -用 ESP32 进行开发最快的方法是安装预编译的工具链。请根据你的操作系点击对应的链接，并按照链接中的指导进行安装。 - -.. toctree:: - :hidden: - - Windows <../get-started/windows-setup-cn> - Linux <../get-started/linux-setup-cn> - MacOS <../get-started/macos-setup> - -+-------------------+-------------------+-------------------+ -| |windows-logo| | |linux-logo| | |macos-logo| | -+-------------------+-------------------+-------------------+ -| `Windows`_ | `Linux`_ | `Mac OS`_ | -+-------------------+-------------------+-------------------+ - -.. |windows-logo| image:: ../_static/windows-logo.png - :target: ../get-started/windows-setup-cn.html - -.. |linux-logo| image:: ../_static/linux-logo.png - :target: ../get-started/linux-setup-cn.html - -.. |macos-logo| image:: ../_static/macos-logo.png - :target: ../get-started/macos-setup.html - -.. _Windows: ../get-started/windows-setup-cn.html -.. _Linux: ../get-started/linux-setup-cn.html -.. _Mac OS: ../get-started/macos-setup.html - -.. note:: - - 我们使用 ``~/esp`` 目录来安装预编译的工具链、ESP-IDF 和示例程序。你也可以使用其它目录，但是需要注意调整相应的指令。 - -你可以安装预编译的工具链或者自定义你的环境，这完全取决于个人经验和偏好。如果你要自定义环境，请参考 :ref:`get-started-customized-setup`。 - -工具链设置完成后，就可以 :ref:`get-started-get-esp-idf-cn` 了。 - -.. _get-started-get-esp-idf-cn: - -获取 ESP-IDF -================= - -.. highlight:: bash - -工具链（包括用于编译和构建应用程序的程序）安装完后，你还需要 ESP32 相关的 API/库。API/库在 `ESP-IDF 仓库 `_ 中。要获取这些 API/库，打开一个终端，进入某个你希望存放 ESP-IDF 的目录，然后 ``git clone`` 以下指令： :: - - cd ~/esp - git clone --recursive https://github.com/espressif/esp-idf.git - -ESP-IDF 将会被下载到 ``~/esp/esp-idf``。 - -.. note:: - - 注意这里有个 ``--recursive`` 选项。如果你克隆 ESP-IDF 时没有带这个选项，你还需要运行额外的命令来获取子模块： :: - - cd ~/esp/esp-idf - git submodule update --init - - -.. _get-started-setup-path-cn: - -设置 ESP-IDF 路径 -===================== - -工具链程序使用环境变量 ``IDF_PATH`` 来访问 ESP-IDF。这个变量应该设置在你的 PC 中，否则工程将不能编译。你可以在每次 PC 重启时手工设置，也可以通过在用户配置文件中定义 ``IDF_PATH`` 变量来永久性设置。要永久性设置，请参考 :doc:`add-idf_path-to-profile` 文档中 :ref:`Windows ` 或 :ref:`Linux and MacOS ` 相关的指导进行操作。 - - -.. _get-started-start-project-cn: - -创建一个工程 -=============== - -现在可以开始创建 ESP32 应用程序了。为了快速开始，我们这里以 IDF 的 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程为例进行说明。 - -将 :example:`get-started/hello_world` 拷贝到 ``~/esp`` 目录： :: - - cd ~/esp - cp -r $IDF_PATH/examples/get-started/hello_world . - -ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照上面的方法进行创建。 - -.. important:: - - esp-idf 构建系统不支持在路径中存在空格。 - -.. _get-started-connect-cn: - -连接 -======= - -还有几个步骤就完成了。在继续后续操作前，先将 ESP32 开发板连接到 PC，然后检查串口号，看看它能否正常通信。如果你不知道如何操作，请查看 Establish Serial Connection with ESP32 中的相关指导。请注意一下端口号，我们在下一步中会用到。 - -.. _get-started-configure-cn: - -配置 -========= - -在终端窗口中，输入 ``cd ~/esp/hello_world`` 进入 ``hello_world`` 所在目录，然后启动工程配置工具 ``menuconfig``： :: - - cd ~/esp/hello_world - make menuconfig - -如果之前的步骤都正确，则会显示下面的菜单： - -.. figure:: ../_static/project-configuration.png - :align: center - :alt: Project configuration - Home window - :figclass: align-center - - 工程配置 - 主窗口 - -在菜单中，进入 ``Serial flasher config`` > ``Default serial port`` 配置串口（工程将会加载到该串口上）。输入回车确认选择，选择 ``< Save >`` 保存配置，然后选择 ``< Exit >`` 退出应用程序。 - -.. note:: - - 在 Windows 系统中，端口号的名称类似 COM1，在 MacOS 中以 ``/dev/cu.`` 开始，而在 Linux 系统中，以 ``/dev/tty`` 开始。 - （详细内容可以参考章节 :doc:`establish-serial-connection`。） - -下面是一些使用 ``menuconfig`` 的小技巧： - -* 使用 up & down 组合键在菜单中上下移动 -* 使用 Enter 键进入一个子菜单，Escape 键退出子菜单或退出整个菜单 -* 输入 ``?`` 查看帮助信息，Enter 键退出帮助屏幕 -* 使用空格键或 ``Y`` 和 ``N`` 键来使能 (Yes) 和禁止 (No) 带有复选框 "``[*]``" 的配置项 -* 当光标在某个配置项上面高亮时，输入 ``?`` 可以直接查看该项的帮助信息 -* 输入 ``/`` 搜索配置项 - -.. note:: - - 如果你是 **Arch Linux** 用户，需要进入 ``SDK tool configuration`` 将 ``Python 2 interpreter`` 从 ``python`` 修改为 ``python2``。 - - -.. _get-started-build-flash-cn: - -编译和烧写 -=============== - -现在可以编译和烧写应用程序了，执行指令： :: - - make flash - -这条命令会编译应用程序和所有的 ESP-IDF 组件，生成 bootloader、分区表和应用程序 bin 文件，并将这些 bin 文件烧写到 ESP32 板子上。 - -.. highlight:: none - -:: - - esptool.py v2.0-beta2 - Flashing binaries to serial port /dev/ttyUSB0 (app at offset 0x10000)... - esptool.py v2.0-beta2 - Connecting........___ - Uploading stub... - Running stub... - Stub running... - Changing baud rate to 921600 - Changed. - Attaching SPI flash... - Configuring flash size... - Auto-detected Flash size: 4MB - Flash params set to 0x0220 - Compressed 11616 bytes to 6695... - Wrote 11616 bytes (6695 compressed) at 0x00001000 in 0.1 seconds (effective 920.5 kbit/s)... - Hash of data verified. - Compressed 408096 bytes to 171625... - Wrote 408096 bytes (171625 compressed) at 0x00010000 in 3.9 seconds (effective 847.3 kbit/s)... - Hash of data verified. - Compressed 3072 bytes to 82... - Wrote 3072 bytes (82 compressed) at 0x00008000 in 0.0 seconds (effective 8297.4 kbit/s)... - Hash of data verified. - - Leaving... - Hard resetting... - -如果没有任何问题，在编译过程结束后将能看到类似上面的消息。最后，板子将会复位，应用程序 "hello_world" 开始启动。 - -如果你想使用 Eclipse IDE 而不是运行 ``make``，请参考 :doc:`Eclipse guide `。 - -.. _get-started-build-monitor-cn: - -监视器 -======= - -如果要查看 "hello_world" 程序是否真的在运行，输入命令 ``make monitor``。这个命令会启动 IDF Monitor 程序： :: - - $ make monitor - MONITOR - --- idf_monitor on /dev/ttyUSB0 115200 --- - --- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H --- - ets Jun 8 2016 00:22:57 - - rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT) - ets Jun 8 2016 00:22:57 - ... - -在启动消息和诊断消息后，你就能看到 "Hello world!" 程序所打印的消息： :: - - ... - Hello world! - Restarting in 10 seconds... - I (211) cpu_start: Starting scheduler on APP CPU. - Restarting in 9 seconds... - Restarting in 8 seconds... - Restarting in 7 seconds... - -要退出监视器，请使用快捷键 ``Ctrl+]``。 - -.. note:: - - 如果串口打印的不是上面显示的消息而是类似下面的乱码： :: - - e���)(Xn@�y.!��(�PW+)��Hn9a؅/9�!�t5��P�~�k��e�ea�5�jA - ~zY��Y(1�,1�� e���)(Xn@�y.!Dr�zY(�jpi�|�+z5Ymvp - - 或者监视器程序启动失败，那么可能你的开发板用的是 26 MHz 晶振，而 ESP-IDF 默认的是 40 MHz 晶振。请退出监视器，回到 :ref:`配置 `，将 :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` 改为 26 MHz，然后再次 :ref:`编译和烧写 `。请在 ``make menuconfig`` 的 Component config --> ESP32-specific --> Main XTAL frequency 中配置。 - -要一次性执行 ``make flash`` 和 ``make monitor``，输入 ``make flash monitor``。参考文档 :doc:`IDF Monitor ` 里的快捷键和更多内容。 - -你已完成 ESP32 的入门！ - -现在你可以尝试其他的示例工程 :idf:`examples`，或者直接开发自己的应用程序。 - -更新 ESP-IDF -============= - -使用 ESP-IDF 一段时间后，你可能想要进行升级来获得新的性能或者对 bug 进行修复。最简单的更新方式是删除已有的 ``esp-idf`` 文件夹然后再克隆一个，即重复 :ref:`get-started-get-esp-idf-cn` 里的操作。 - -另外一种方法是只更新有改动的部分，如果你不容易登陆 GitHub，那么这种方法比较合适。执行以下命令： :: - - cd ~/esp/esp-idf - git pull - git submodule update --init --recursive - -``git pull`` 指令是从 ESP-IDF 仓库中获取合并更新。``git submodule update --init --recursive`` 用来更新现有的子模块或拷贝新的子模块。在 GitHub 上，子模块链接到其他仓库，所以需要这个额外的指令来下载到你的电脑里。 - -如果你想使用某一版本的 ESP-IDF，比如 `v2.1` 版本，请执行以下指令： :: - - cd ~/esp - git clone https://github.com/espressif/esp-idf.git esp-idf-v2.1 - cd esp-idf-v2.1/ - git checkout v2.1 - git submodule update --init --recursive - -然后 :doc:`add-idf_path-to-profile`，这样工具链脚本就能够知道这一版本的 ESP-IDF 的具体位置。 - - -相关文档 -================= - -.. toctree:: - :maxdepth: 1 - - ../get-started/add-idf_path-to-profile - ../get-started/establish-serial-connection - ../get-started/make-project - ../get-started/eclipse-setup - ../get-started/idf-monitor - ../get-started/toolchain-setup-scratch diff --git a/docs/get-started/linux-setup-cn.rst b/docs/get-started/linux-setup-cn.rst deleted file mode 100644 index 7eefd3a2d3..0000000000 --- a/docs/get-started/linux-setup-cn.rst +++ /dev/null @@ -1,94 +0,0 @@ -***************************** -Linux 平台工具链的标准设置 -***************************** - -安装前提 -===================== - -编译 ESP-IDF 需要以下软件包： - -- CentOS 7:: - - sudo yum install git wget make ncurses-devel flex bison gperf python pyserial - -- Ubuntu and Debian:: - - sudo apt-get install git wget make libncurses-dev flex bison gperf python python-serial - -- Arch:: - - sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial - -工具链的设置 -=============== - -Linux 版的 ESP32 工具链可以从 Espressif 的网站下载： - -- 64-bit Linux： - - https://dl.espressif.com/dl/xtensa-esp32-elf-linux64-1.22.0-80-g6c4433a-5.2.0.tar.gz - -- 32-bit Linux： - - https://dl.espressif.com/dl/xtensa-esp32-elf-linux32-1.22.0-80-g6c4433a-5.2.0.tar.gz - -1. 下载完成后，将它解压到 ``~/esp`` 目录： :: - - mkdir -p ~/esp - cd ~/esp - tar -xzf ~/Downloads/xtensa-esp32-elf-linux64-1.22.0-80-g6c4433a-5.2.0.tar.gz - -.. _setup-linux-toolchain-add-it-to-path-cn: - -2. 工具链将会被解压到 ``~/esp/xtensa-esp32-elf/`` 目录。 - - 要使用工具链，你还需要在 ``~/.profile`` 文件中更新环境变量 ``PATH``。要使 ``xtensa-esp32-elf`` 在所有的终端会话中都有效，需要将下面这一行代码添加到你的 ``~/.profile`` 文件中： :: - - export PATH="$PATH:$HOME/esp/xtensa-esp32-elf/bin" - - 或者你也可以给上面的命令创建一个别名。这样做的好处是，你只在需要使用它的时候才获取工具链。将下面这行代码添加到 ``~/.profile`` 文件中即可： :: - - alias get_esp32='export PATH="$PATH:$HOME/esp/xtensa-esp32-elf/bin"' - - 然后，当你需要使用工具链时，在命令行输入 ``get_esp32``，然后工具链会自动添加到你的 ``PATH`` 中。 - - .. note:: - - 如果将 ``/bin/bash`` 设置为登录 shell，且同时存在 ``.bash_profile`` 和 ``.profile``，则更新 ``.bash_profile`` 。 - -3. 退出并重新登录以使 ``.profile`` 更改生效。 运行以下命令来检查 ``PATH`` 设置是否正确： :: - - printenv PATH - - 检查一下字符串的末尾是否包含类似的工具链的路径： :: - - $ printenv PATH - /home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/home/user-name/esp/xtensa-esp32-elf/bin - - 除了 ``/home/user-name``，应该有具体的安装的主路径。 - -权限问题 /dev/ttyUSB0 ------------------------------- - -某些 Linux 版本可能在烧写 ESP32 时会出现 ``Failed to open port /dev/ttyUSB0`` 错误消息。 :ref:`可以通过将当前用户添加到拨出组来解决`。 - -Arch Linux 用户 ----------------- - -在 Arch 中运行预编译的 gdb (xtensa-esp32-elf-gdb) 需要 ncurses 5，但是 Arch 使用的是 ncurses 6。在 AUR_ 中向下兼容的库文件，可用于本地和 lib32 的配置： - -- https://aur.archlinux.org/packages/ncurses5-compat-libs/ -- https://aur.archlinux.org/packages/lib32-ncurses5-compat-libs/ - -在安装这些软件包之前，你可能需要将作者的公钥添加到你的钥匙圈中，上面链接中的“Comments”部分有所叙述。 - -或者，你也可以使用 crosstool-NG 编译一个链接 ncurses 6 的 gdb。 - -后续步骤 -========== - -要继续设置开发环境，请参考 :ref:`get-started-get-esp-idf-cn` 一节。 - - -.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository - diff --git a/docs/get-started/windows-setup-cn.rst b/docs/get-started/windows-setup-cn.rst deleted file mode 100644 index 3b67552ebd..0000000000 --- a/docs/get-started/windows-setup-cn.rst +++ /dev/null @@ -1,63 +0,0 @@ -*************************************** -Windows 平台工具链的标准设置 -*************************************** - -引言 -============ - -Windows 没有内置的 "make" 环境，因此如果要安装工具链，你需要一个 GNU 兼容环境。我们这里使用 MSYS2_ 来提供该环境。你不需要一直使用这个环境（你可以使用 :doc:`Eclipse ` 或其它前端工具），但是它是在后台运行的。 - -工具链的设置 -=============== - -快速设置的方法是从 dl.espressif.com 下载集成在一起的工具链和 MSYS2 压缩文件： - -https://dl.espressif.com/dl/esp32_win32_msys2_environment_and_toolchain-20180110.zip - -将 zip 压缩文件解压到 ``C:\`` (或其它路径，这里假设是 ``C:\``)，它会使用预先准备的环境创建一个 ``msys32`` 目录。 - -检出 -============ - -运行 ``C:\msys32\mingw32.exe`` 打开一个 MSYS2 的终端窗口。该窗口的环境是一个 bash shell。 - -.. figure:: ../_static/msys2-terminal-window.png - :align: center - :alt: MSYS2 MINGW32 shell window - :figclass: align-center - - MSYS2 终端窗口 - -后续步骤将会使用这个窗口来为 ESP32 设置开发环境。 - -后续步骤 -========== - -要继续设置开发环境，请参考 :ref:`get-started-get-esp-idf-cn` 一节。 - -更新环境 -======================== - -当 IDF 更新时，有时需要新的工具链，或者将新的需求添加到 Windows MSYS2 环境中。要将旧版本的预编译环境中的数据移动到新版本： - -- 把旧的 MSYS2 环境（即 ``C:\msys32``）移动/重命名为不同的目录（即 ``C:\msys32_old``）。 -- 按照前文所述步骤下载新的预编译环境。 -- 将新的 MSYS2 环境解压缩到 ``C:\msys32`` （或其他位置）。 -- 找到旧的 ``C:\msys32_old\home`` 目录并把它移到 ``C:\msys32``。 -- 如果你不再需要 ``C:\msys32_old`` 可以将它删除。 - -你可以在系统上拥有独立的不同的 MSYS2 环境，前提是在不同的目录中。 - -或者，:ref:`你也可以更新现有的环境而不是下载新环境 `，但是这样更复杂。 - -相关文档 -================= - -.. toctree:: - :maxdepth: 1 - - windows-setup-scratch - - -.. _MSYS2: https://msys2.github.io/ - diff --git a/docs/zh_CN/COPYRIGHT.rst b/docs/zh_CN/COPYRIGHT.rst new file mode 100644 index 0000000000..5caf70ca8d --- /dev/null +++ b/docs/zh_CN/COPYRIGHT.rst @@ -0,0 +1 @@ +.. include:: ../en/COPYRIGHT.rst \ No newline at end of file diff --git a/docs/zh_CN/Makefile b/docs/zh_CN/Makefile new file mode 100644 index 0000000000..cc32abbd51 --- /dev/null +++ b/docs/zh_CN/Makefile @@ -0,0 +1,201 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) -w sphinx-warning-log.txt . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/ReadtheDocsTemplate" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ReadtheDocsTemplate" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +gh-linkcheck: + @echo "Checking for hardcoded GitHub links" + @if (find ../ -name '*.rst' | xargs grep \ + 'https://github.com/espressif/esp-idf/tree\|https://github.com/espressif/esp-idf/blob\|https://github.com/espressif/esp-idf/raw'\ + ); \ + then \ + echo "WARNINIG: Some .rst files contain hardcoded Github links."; \ + echo "Please check above output and replace links with one of the following:"; \ + echo "- :idf:\`dir\` - points to directory inside ESP-IDF"; \ + echo "- :idf_file:\`file\` - points to file inside ESP-IDF"; \ + echo "- :idf_raw:\`file\` - points to raw view of the file inside ESP-IDF"; \ + echo "- :component:\`dir\` - points to directory inside ESP-IDF components dir"; \ + echo "- :component_file:\`file\` - points to file inside ESP-IDF components dir"; \ + echo "- :component_raw:\`file\` - points to raw view of the file inside ESP-IDF"; \ + echo " components dir"; \ + echo "- :example:\`dir\` - points to directory inside ESP-IDF examples dir"; \ + echo "- :example_file:\`file\` - points to file inside ESP-IDF examples dir"; \ + echo "- :example_raw:\`file\` - points to raw view of the file inside ESP-IDF"; \ + echo " examples dir"; \ + echo "These link types will point to the correct GitHub version automatically"; \ + exit 1; \ + fi + @echo "No hardcoded links found" + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/zh_CN/about.rst b/docs/zh_CN/about.rst new file mode 100644 index 0000000000..63cda26962 --- /dev/null +++ b/docs/zh_CN/about.rst @@ -0,0 +1 @@ +.. include:: ../en/about.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/SYSVIEW_FreeRTOS.txt b/docs/zh_CN/api-guides/SYSVIEW_FreeRTOS.txt new file mode 100644 index 0000000000..b19b47572b --- /dev/null +++ b/docs/zh_CN/api-guides/SYSVIEW_FreeRTOS.txt @@ -0,0 +1,104 @@ +128 vTaskAllocateMPURegions xTask=%t pxRegions=%u +33 vTaskDelete xTaskToDelete=%t +34 vTaskDelay xTicksToDelay=%u +35 vTaskDelayUntil +129 uxTaskPriorityGet xTask=%t +56 uxTaskPriorityGetFromISR xTask=%t +130 eTaskGetState xTask=%t +55 vTaskPrioritySet xTask=%t uxNewPriority=%u +36 vTaskSuspend xTaskToSuspend=%t +40 vTaskResume xTaskToResume=%t +43 xTaskResumeFromISR xTaskToResume=%t +131 vTaskStartScheduler +132 vTaskEndScheduler +133 vTaskSuspendAll +134 xTaskResumeAll +135 xTaskGetTickCount +57 xTaskGetTickCountFromISR +136 uxTaskGetNumberOfTasks +137 pcTaskGetTaskName xTaskToQuery=%t +138 uxTaskGetStackHighWaterMark xTask=%t +139 vTaskSetApplicationTaskTag xTask=%t pxHookFunction=%u +140 xTaskGetApplicationTaskTag xTask=%t +141 vTaskSetThreadLocalStoragePointer xTaskToSet=%T xIndex=%u pvValue=%u +142 pvTaskGetThreadLocalStoragePointer xTaskToQuery=%T xIndex=%u +143 xTaskCallApplicationTaskHook xTask=%T pvParameter=%u +144 xTaskGetIdleTaskHandle +145 uxTaskGetSystemState pxTaskStatusArray=%u uxArraySize=%u pulTotalRunTime=%u +146 vTaskList pcWriteBuffer=%u +147 vTaskGetRunTimeStats pcWriteBuffer=%u +44 xTaskGenericNotify xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u +45 xTaskGenericNotifyFromISR xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u pxHigherPriorityTaskWoken=%u +46 xTaskNotifyWait ulBitsToClearOnEntry=%u ulBitsToClearOnExit=%u pulNotificationValue=%u xTicksToWait=%u +38 vTaskNotifyGiveFromISR xTaskToNotify=%t pxHigherPriorityTaskWoken=%u +37 ulTaskNotifyTake xClearCountOnExit=%u xTicksToWait=%u +148 xTaskNotifyStateClear xTask=%t +149 xTaskGetCurrentTaskHandle +150 vTaskSetTimeOutState pxTimeOut=%u +151 xTaskCheckForTimeOut pxTimeOut=%u pxTicksToWait=%u +152 vTaskMissedYield +153 xTaskGetSchedulerState +39 vTaskPriorityInherit pxMutexHolder=%p +42 xTaskPriorityDisinherit pxMutexHolder=%p +154 xTaskGenericCreate pxTaskCode=%u pcName=%u usStackDepth=%u pvParameters=%u uxPriority=%u pxCreatedTask=%u puxStackBuffer=%u xRegions=%u +155 uxTaskGetTaskNumber xTask=%u +156 vTaskSetTaskNumber xTask=%u uxHandle=%u +41 vTaskStepTick xTicksToJump=%u +157 eTaskConfirmSleepModeStatus +158 xTimerCreate pcTimerName=%u xTimerPeriodInTicks=%u uxAutoReload=%u pvTimerID=%u pxCallbackFunction=%u +159 pvTimerGetTimerID xTimer=%u +160 vTimerSetTimerID xTimer=%u pvNewID=%u +161 xTimerIsTimerActive xTimer=%u +162 xTimerGetTimerDaemonTaskHandle +163 xTimerPendFunctionCallFromISR xFunctionToPend=%u pvParameter1=%u ulParameter2=%u pxHigherPriorityTaskWoken=%u +164 xTimerPendFunctionCall xFunctionToPend=%u pvParameter1=%u ulParameter2=%u xTicksToWait=%u +165 pcTimerGetTimerName xTimer=%u +166 xTimerCreateTimerTask +167 xTimerGenericCommand xTimer=%u xCommandID=%u xOptionalValue=%u pxHigherPriorityTaskWoken=%u xTicksToWait=%u +53 xQueueGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u +50 xQueuePeekFromISR xQueue=%I pvBuffer=%p +49 xQueueGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeek=%u +168 uxQueueMessagesWaiting xQueue=%I +169 uxQueueSpacesAvailable xQueue=%I +48 vQueueDelete xQueue=%I +54 xQueueGenericSendFromISR xQueue=%I pvItemToQueue=%p pxHigherPriorityTaskWoken=%u xCopyPosition=%u +61 xQueueGiveFromISR xQueue=%I pxHigherPriorityTaskWoken=%u +51 xQueueReceiveFromISR xQueue=%I pvBuffer=%p pxHigherPriorityTaskWoken=%u +62 xQueueIsQueueEmptyFromISR xQueue=%I +63 xQueueIsQueueFullFromISR xQueue=%I +170 uxQueueMessagesWaitingFromISR xQueue=%I +171 xQueueAltGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u +172 xQueueAltGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeeking=%u +173 xQueueCRSendFromISR xQueue=%I pvItemToQueue=%p xCoRoutinePreviouslyWoken=%u +174 xQueueCRReceiveFromISR xQueue=%I pvBuffer=%p pxTaskWoken=%u +175 xQueueCRSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u +176 xQueueCRReceive xQueue=%I pvBuffer=%p xTicksToWait=%u +177 xQueueCreateMutex ucQueueType=%u +178 xQueueCreateCountingSemaphore uxMaxCount=%u uxInitialCount=%u +179 xQueueGetMutexHolder xSemaphore=%u +180 xQueueTakeMutexRecursive xMutex=%u xTicksToWait=%u +181 xQueueGiveMutexRecursive pxMutex=%u +52 vQueueAddToRegistry xQueue=%I pcName=%u +182 vQueueUnregisterQueue xQueue=%I +47 xQueueGenericCreate uxQueueLength=%u uxItemSize=%u ucQueueType=%u +183 xQueueCreateSet uxEventQueueLength=%u +184 xQueueAddToSet xQueueOrSemaphore=%u xQueueSet=%u +185 xQueueRemoveFromSet xQueueOrSemaphore=%u xQueueSet=%u +186 xQueueSelectFromSet xQueueSet=%u xTicksToWait=%u +187 xQueueSelectFromSetFromISR xQueueSet=%u +188 xQueueGenericReset xQueue=%I xNewQueue=%u +189 vListInitialise pxList=%u +190 vListInitialiseItem pxItem=%u +191 vListInsert pxList=%u pxNewListItem=%u +192 vListInsertEnd pxList=%u pxNewListItem=%u +193 uxListRemove pxItemToRemove=%u +194 xEventGroupCreate +195 xEventGroupWaitBits xEventGroup=%u uxBitsToWaitFor=%u xClearOnExit=%u xWaitForAllBits=%u xTicksToWait=%u +196 xEventGroupClearBits xEventGroup=%u uxBitsToClear=%u +58 xEventGroupClearBitsFromISR xEventGroup=%u uxBitsToSet=%u +197 xEventGroupSetBits xEventGroup=%u uxBitsToSet=%u +59 xEventGroupSetBitsFromISR xEventGroup=%u uxBitsToSet=%u pxHigherPriorityTaskWoken=%u +198 xEventGroupSync xEventGroup=%u uxBitsToSet=%u uxBitsToWaitFor=%u xTicksToWait=%u +60 xEventGroupGetBitsFromISR xEventGroup=%u +199 vEventGroupDelete xEventGroup=%u +200 uxEventGroupGetNumber xEventGroup=%u diff --git a/docs/zh_CN/api-guides/app_trace.rst b/docs/zh_CN/api-guides/app_trace.rst new file mode 100644 index 0000000000..59a435e3a3 --- /dev/null +++ b/docs/zh_CN/api-guides/app_trace.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/app_trace.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/build-system.rst b/docs/zh_CN/api-guides/build-system.rst new file mode 100644 index 0000000000..12ac41ed8a --- /dev/null +++ b/docs/zh_CN/api-guides/build-system.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/build-system.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/console.rst b/docs/zh_CN/api-guides/console.rst new file mode 100644 index 0000000000..dd6f985af8 --- /dev/null +++ b/docs/zh_CN/api-guides/console.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/console.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/core_dump.rst b/docs/zh_CN/api-guides/core_dump.rst new file mode 100644 index 0000000000..5acbd83246 --- /dev/null +++ b/docs/zh_CN/api-guides/core_dump.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/core_dump.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/deep-sleep-stub.rst b/docs/zh_CN/api-guides/deep-sleep-stub.rst new file mode 100644 index 0000000000..826dbef81d --- /dev/null +++ b/docs/zh_CN/api-guides/deep-sleep-stub.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/deep-sleep-stub.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/external-ram.rst b/docs/zh_CN/api-guides/external-ram.rst new file mode 100644 index 0000000000..11fe46540d --- /dev/null +++ b/docs/zh_CN/api-guides/external-ram.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/external-ram.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/freertos-smp.rst b/docs/zh_CN/api-guides/freertos-smp.rst new file mode 100644 index 0000000000..16a4ba2d28 --- /dev/null +++ b/docs/zh_CN/api-guides/freertos-smp.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/freertos-smp.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/general-notes.rst b/docs/zh_CN/api-guides/general-notes.rst new file mode 100644 index 0000000000..fd8bf47056 --- /dev/null +++ b/docs/zh_CN/api-guides/general-notes.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/general-notes.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/hlinterrupts.rst b/docs/zh_CN/api-guides/hlinterrupts.rst new file mode 100644 index 0000000000..6a77766fc5 --- /dev/null +++ b/docs/zh_CN/api-guides/hlinterrupts.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/hlinterrupts.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst new file mode 100644 index 0000000000..a6a7d85661 --- /dev/null +++ b/docs/zh_CN/api-guides/index.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/index.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/building-openocd-linux.rst b/docs/zh_CN/api-guides/jtag-debugging/building-openocd-linux.rst new file mode 100644 index 0000000000..36c4701ad8 --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/building-openocd-linux.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/building-openocd-linux.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/building-openocd-macos.rst b/docs/zh_CN/api-guides/jtag-debugging/building-openocd-macos.rst new file mode 100644 index 0000000000..70481a7bf3 --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/building-openocd-macos.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/building-openocd-macos.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/building-openocd-windows.rst b/docs/zh_CN/api-guides/jtag-debugging/building-openocd-windows.rst new file mode 100644 index 0000000000..34cef1021f --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/building-openocd-windows.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/building-openocd-windows.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst b/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst new file mode 100644 index 0000000000..720df4b505 --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/configure-other-jtag.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst b/docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst new file mode 100644 index 0000000000..d79518837d --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/configure-wrover.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/debugging-examples.rst b/docs/zh_CN/api-guides/jtag-debugging/debugging-examples.rst new file mode 100644 index 0000000000..ee8c9594c0 --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/debugging-examples.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/debugging-examples.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/index.rst b/docs/zh_CN/api-guides/jtag-debugging/index.rst new file mode 100644 index 0000000000..8a42b5678f --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/index.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/index.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/setup-openocd-linux.rst b/docs/zh_CN/api-guides/jtag-debugging/setup-openocd-linux.rst new file mode 100644 index 0000000000..16059fc9c5 --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/setup-openocd-linux.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/setup-openocd-linux.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/setup-openocd-macos.rst b/docs/zh_CN/api-guides/jtag-debugging/setup-openocd-macos.rst new file mode 100644 index 0000000000..fd8f49ba61 --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/setup-openocd-macos.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/setup-openocd-macos.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/setup-openocd-windows.rst b/docs/zh_CN/api-guides/jtag-debugging/setup-openocd-windows.rst new file mode 100644 index 0000000000..cb3368c6ae --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/setup-openocd-windows.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/setup-openocd-windows.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/tips-and-quirks.rst b/docs/zh_CN/api-guides/jtag-debugging/tips-and-quirks.rst new file mode 100644 index 0000000000..aaf7dfadfd --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/tips-and-quirks.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/tips-and-quirks.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst b/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst new file mode 100644 index 0000000000..e34bc09731 --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-guides/jtag-debugging/using-debugger.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/partition-tables.rst b/docs/zh_CN/api-guides/partition-tables.rst new file mode 100644 index 0000000000..10eca64086 --- /dev/null +++ b/docs/zh_CN/api-guides/partition-tables.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/partition-tables.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/romconsole.rst b/docs/zh_CN/api-guides/romconsole.rst new file mode 100644 index 0000000000..59791099eb --- /dev/null +++ b/docs/zh_CN/api-guides/romconsole.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/romconsole.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/ulp.rst b/docs/zh_CN/api-guides/ulp.rst new file mode 100644 index 0000000000..976d6db286 --- /dev/null +++ b/docs/zh_CN/api-guides/ulp.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/ulp.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/ulp_instruction_set.rst b/docs/zh_CN/api-guides/ulp_instruction_set.rst new file mode 100755 index 0000000000..e36036d269 --- /dev/null +++ b/docs/zh_CN/api-guides/ulp_instruction_set.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/ulp_instruction_set.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/ulp_macros.rst b/docs/zh_CN/api-guides/ulp_macros.rst new file mode 100644 index 0000000000..408f1d6952 --- /dev/null +++ b/docs/zh_CN/api-guides/ulp_macros.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/ulp_macros.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/unit-tests.rst b/docs/zh_CN/api-guides/unit-tests.rst new file mode 100644 index 0000000000..d42993f788 --- /dev/null +++ b/docs/zh_CN/api-guides/unit-tests.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/unit-tests.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/wifi.rst b/docs/zh_CN/api-guides/wifi.rst new file mode 100644 index 0000000000..50c7164e64 --- /dev/null +++ b/docs/zh_CN/api-guides/wifi.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/wifi.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/bt_common.rst b/docs/zh_CN/api-reference/bluetooth/bt_common.rst new file mode 100644 index 0000000000..e6f9ae0727 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/bt_common.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/bt_common.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/bt_le.rst b/docs/zh_CN/api-reference/bluetooth/bt_le.rst new file mode 100644 index 0000000000..24b978c977 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/bt_le.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/bt_le.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/classic_bt.rst b/docs/zh_CN/api-reference/bluetooth/classic_bt.rst new file mode 100644 index 0000000000..7ce047bbbf --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/classic_bt.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/classic_bt.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/controller_vhci.rst b/docs/zh_CN/api-reference/bluetooth/controller_vhci.rst new file mode 100644 index 0000000000..da752e56bf --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/controller_vhci.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/controller_vhci.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_a2dp.rst b/docs/zh_CN/api-reference/bluetooth/esp_a2dp.rst new file mode 100644 index 0000000000..1c93065650 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_a2dp.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_a2dp.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_avrc.rst b/docs/zh_CN/api-reference/bluetooth/esp_avrc.rst new file mode 100644 index 0000000000..daf21d215c --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_avrc.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_avrc.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_blufi.rst b/docs/zh_CN/api-reference/bluetooth/esp_blufi.rst new file mode 100644 index 0000000000..ab40ae6315 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_blufi.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_blufi.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_bt_defs.rst b/docs/zh_CN/api-reference/bluetooth/esp_bt_defs.rst new file mode 100644 index 0000000000..9e6b668f80 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_bt_defs.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_bt_defs.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_bt_device.rst b/docs/zh_CN/api-reference/bluetooth/esp_bt_device.rst new file mode 100644 index 0000000000..9bd127aa5d --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_bt_device.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_bt_device.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_bt_main.rst b/docs/zh_CN/api-reference/bluetooth/esp_bt_main.rst new file mode 100644 index 0000000000..e1b655a67b --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_bt_main.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_bt_main.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_gap_ble.rst b/docs/zh_CN/api-reference/bluetooth/esp_gap_ble.rst new file mode 100644 index 0000000000..476a00a406 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_gap_ble.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_gap_ble.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_gap_bt.rst b/docs/zh_CN/api-reference/bluetooth/esp_gap_bt.rst new file mode 100644 index 0000000000..1984edefa0 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_gap_bt.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_gap_bt.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_gatt_defs.rst b/docs/zh_CN/api-reference/bluetooth/esp_gatt_defs.rst new file mode 100644 index 0000000000..5329282e5e --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_gatt_defs.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_gatt_defs.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_gattc.rst b/docs/zh_CN/api-reference/bluetooth/esp_gattc.rst new file mode 100644 index 0000000000..c53df82adc --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_gattc.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_gattc.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_gatts.rst b/docs/zh_CN/api-reference/bluetooth/esp_gatts.rst new file mode 100644 index 0000000000..87f8b278e4 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_gatts.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_gatts.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/esp_spp.rst b/docs/zh_CN/api-reference/bluetooth/esp_spp.rst new file mode 100644 index 0000000000..8dd9ca243f --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_spp.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_spp.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/bluetooth/index.rst b/docs/zh_CN/api-reference/bluetooth/index.rst new file mode 100644 index 0000000000..0379710c38 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/index.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/index.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/ethernet/esp_eth.rst b/docs/zh_CN/api-reference/ethernet/esp_eth.rst new file mode 100644 index 0000000000..00cb4e891e --- /dev/null +++ b/docs/zh_CN/api-reference/ethernet/esp_eth.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/ethernet/esp_eth.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/ethernet/index.rst b/docs/zh_CN/api-reference/ethernet/index.rst new file mode 100644 index 0000000000..949fe213ee --- /dev/null +++ b/docs/zh_CN/api-reference/ethernet/index.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/ethernet/index.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/index.rst b/docs/zh_CN/api-reference/index.rst new file mode 100644 index 0000000000..9c72376735 --- /dev/null +++ b/docs/zh_CN/api-reference/index.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-reference/index.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/kconfig.rst b/docs/zh_CN/api-reference/kconfig.rst new file mode 100644 index 0000000000..db107787e4 --- /dev/null +++ b/docs/zh_CN/api-reference/kconfig.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-reference/kconfig.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/adc.rst b/docs/zh_CN/api-reference/peripherals/adc.rst new file mode 100644 index 0000000000..992087787b --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/adc.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/adc.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/dac.rst b/docs/zh_CN/api-reference/peripherals/dac.rst new file mode 100644 index 0000000000..f0f7f71663 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/dac.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/dac.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/gpio.rst b/docs/zh_CN/api-reference/peripherals/gpio.rst new file mode 100644 index 0000000000..52fdd16559 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/gpio.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/gpio.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/i2c.rst b/docs/zh_CN/api-reference/peripherals/i2c.rst new file mode 100644 index 0000000000..f32a051b66 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/i2c.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/i2c.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/i2s.rst b/docs/zh_CN/api-reference/peripherals/i2s.rst new file mode 100644 index 0000000000..493e5b949b --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/i2s.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/i2s.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/index.rst b/docs/zh_CN/api-reference/peripherals/index.rst new file mode 100644 index 0000000000..3ac36bb8e4 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/index.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/index.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/ledc.rst b/docs/zh_CN/api-reference/peripherals/ledc.rst new file mode 100644 index 0000000000..d2374420f7 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/ledc.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/ledc.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/mcpwm.rst b/docs/zh_CN/api-reference/peripherals/mcpwm.rst new file mode 100644 index 0000000000..a918a58c90 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/mcpwm.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/mcpwm.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/pcnt.rst b/docs/zh_CN/api-reference/peripherals/pcnt.rst new file mode 100644 index 0000000000..c4d1cf83db --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/pcnt.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/pcnt.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/rmt.rst b/docs/zh_CN/api-reference/peripherals/rmt.rst new file mode 100644 index 0000000000..4b79094eb2 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/rmt.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/rmt.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/sigmadelta.rst b/docs/zh_CN/api-reference/peripherals/sigmadelta.rst new file mode 100644 index 0000000000..8a26b7a8d8 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/sigmadelta.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/sigmadelta.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/spi_master.rst b/docs/zh_CN/api-reference/peripherals/spi_master.rst new file mode 100644 index 0000000000..6ff2b181c8 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/spi_master.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/spi_master.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/spi_slave.rst b/docs/zh_CN/api-reference/peripherals/spi_slave.rst new file mode 100644 index 0000000000..21dcf9b0a0 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/spi_slave.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/spi_slave.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/timer.rst b/docs/zh_CN/api-reference/peripherals/timer.rst new file mode 100644 index 0000000000..777ec06c22 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/timer.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/timer.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/touch_pad.rst b/docs/zh_CN/api-reference/peripherals/touch_pad.rst new file mode 100644 index 0000000000..15df578a77 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/touch_pad.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/touch_pad.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/peripherals/uart.rst b/docs/zh_CN/api-reference/peripherals/uart.rst new file mode 100644 index 0000000000..3a95c0b7a9 --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/uart.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/uart.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/protocols/index.rst b/docs/zh_CN/api-reference/protocols/index.rst new file mode 100644 index 0000000000..9cf7b7072e --- /dev/null +++ b/docs/zh_CN/api-reference/protocols/index.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/protocols/index.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/protocols/mdns.rst b/docs/zh_CN/api-reference/protocols/mdns.rst new file mode 100644 index 0000000000..3f82c5d807 --- /dev/null +++ b/docs/zh_CN/api-reference/protocols/mdns.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/protocols/mdns.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/storage/fatfs.rst b/docs/zh_CN/api-reference/storage/fatfs.rst new file mode 100644 index 0000000000..a867563eba --- /dev/null +++ b/docs/zh_CN/api-reference/storage/fatfs.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/storage/fatfs.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/storage/index.rst b/docs/zh_CN/api-reference/storage/index.rst new file mode 100644 index 0000000000..f30a807b73 --- /dev/null +++ b/docs/zh_CN/api-reference/storage/index.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/storage/index.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/storage/nvs_flash.rst b/docs/zh_CN/api-reference/storage/nvs_flash.rst new file mode 100644 index 0000000000..88fef50af6 --- /dev/null +++ b/docs/zh_CN/api-reference/storage/nvs_flash.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/storage/nvs_flash.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/storage/sdmmc.rst b/docs/zh_CN/api-reference/storage/sdmmc.rst new file mode 100644 index 0000000000..b2db3d718b --- /dev/null +++ b/docs/zh_CN/api-reference/storage/sdmmc.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/storage/sdmmc.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/storage/spi_flash.rst b/docs/zh_CN/api-reference/storage/spi_flash.rst new file mode 100644 index 0000000000..1856da13f8 --- /dev/null +++ b/docs/zh_CN/api-reference/storage/spi_flash.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/storage/spi_flash.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/storage/spiffs.rst b/docs/zh_CN/api-reference/storage/spiffs.rst new file mode 100644 index 0000000000..4179e3c661 --- /dev/null +++ b/docs/zh_CN/api-reference/storage/spiffs.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/storage/spiffs.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/storage/vfs.rst b/docs/zh_CN/api-reference/storage/vfs.rst new file mode 100644 index 0000000000..fa1aef627f --- /dev/null +++ b/docs/zh_CN/api-reference/storage/vfs.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/storage/vfs.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/storage/wear-levelling.rst b/docs/zh_CN/api-reference/storage/wear-levelling.rst new file mode 100644 index 0000000000..065b714541 --- /dev/null +++ b/docs/zh_CN/api-reference/storage/wear-levelling.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/storage/wear-levelling.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/app_trace.rst b/docs/zh_CN/api-reference/system/app_trace.rst new file mode 100644 index 0000000000..64afb5e2f2 --- /dev/null +++ b/docs/zh_CN/api-reference/system/app_trace.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/app_trace.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/base_mac_address.rst b/docs/zh_CN/api-reference/system/base_mac_address.rst new file mode 100644 index 0000000000..05cfa83ba4 --- /dev/null +++ b/docs/zh_CN/api-reference/system/base_mac_address.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/base_mac_address.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/esp_timer.rst b/docs/zh_CN/api-reference/system/esp_timer.rst new file mode 100644 index 0000000000..2f78425259 --- /dev/null +++ b/docs/zh_CN/api-reference/system/esp_timer.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/esp_timer.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/freertos.rst b/docs/zh_CN/api-reference/system/freertos.rst new file mode 100644 index 0000000000..67f97f5056 --- /dev/null +++ b/docs/zh_CN/api-reference/system/freertos.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/freertos.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/heap_debug.rst b/docs/zh_CN/api-reference/system/heap_debug.rst new file mode 100644 index 0000000000..d8bc647943 --- /dev/null +++ b/docs/zh_CN/api-reference/system/heap_debug.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/heap_debug.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/hooks.rst b/docs/zh_CN/api-reference/system/hooks.rst new file mode 100644 index 0000000000..487fb99107 --- /dev/null +++ b/docs/zh_CN/api-reference/system/hooks.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/hooks.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/index.rst b/docs/zh_CN/api-reference/system/index.rst new file mode 100644 index 0000000000..cdf03b734d --- /dev/null +++ b/docs/zh_CN/api-reference/system/index.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/index.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/intr_alloc.rst b/docs/zh_CN/api-reference/system/intr_alloc.rst new file mode 100644 index 0000000000..7e5576cd45 --- /dev/null +++ b/docs/zh_CN/api-reference/system/intr_alloc.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/intr_alloc.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/ipc.rst b/docs/zh_CN/api-reference/system/ipc.rst new file mode 100644 index 0000000000..16ce297d14 --- /dev/null +++ b/docs/zh_CN/api-reference/system/ipc.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/ipc.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/log.rst b/docs/zh_CN/api-reference/system/log.rst new file mode 100644 index 0000000000..9370697449 --- /dev/null +++ b/docs/zh_CN/api-reference/system/log.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/log.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/mem_alloc.rst b/docs/zh_CN/api-reference/system/mem_alloc.rst new file mode 100644 index 0000000000..3b84553444 --- /dev/null +++ b/docs/zh_CN/api-reference/system/mem_alloc.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/mem_alloc.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/ota.rst b/docs/zh_CN/api-reference/system/ota.rst new file mode 100644 index 0000000000..41ed0bcb7e --- /dev/null +++ b/docs/zh_CN/api-reference/system/ota.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/ota.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/power_management.rst b/docs/zh_CN/api-reference/system/power_management.rst new file mode 100644 index 0000000000..e55e0543a2 --- /dev/null +++ b/docs/zh_CN/api-reference/system/power_management.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/power_management.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/sleep_modes.rst b/docs/zh_CN/api-reference/system/sleep_modes.rst new file mode 100644 index 0000000000..3add4e8efa --- /dev/null +++ b/docs/zh_CN/api-reference/system/sleep_modes.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/sleep_modes.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/wdts.rst b/docs/zh_CN/api-reference/system/wdts.rst new file mode 100644 index 0000000000..65f9c73d2a --- /dev/null +++ b/docs/zh_CN/api-reference/system/wdts.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/wdts.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/template.rst b/docs/zh_CN/api-reference/template.rst new file mode 100644 index 0000000000..a15cc6e4f9 --- /dev/null +++ b/docs/zh_CN/api-reference/template.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-reference/template.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/wifi/esp_now.rst b/docs/zh_CN/api-reference/wifi/esp_now.rst new file mode 100644 index 0000000000..6023755f6b --- /dev/null +++ b/docs/zh_CN/api-reference/wifi/esp_now.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/wifi/esp_now.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/wifi/esp_smartconfig.rst b/docs/zh_CN/api-reference/wifi/esp_smartconfig.rst new file mode 100644 index 0000000000..251cc590a1 --- /dev/null +++ b/docs/zh_CN/api-reference/wifi/esp_smartconfig.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/wifi/esp_smartconfig.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/wifi/esp_wifi.rst b/docs/zh_CN/api-reference/wifi/esp_wifi.rst new file mode 100644 index 0000000000..7d88405f5a --- /dev/null +++ b/docs/zh_CN/api-reference/wifi/esp_wifi.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/wifi/esp_wifi.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/wifi/index.rst b/docs/zh_CN/api-reference/wifi/index.rst new file mode 100644 index 0000000000..5cf31c597f --- /dev/null +++ b/docs/zh_CN/api-reference/wifi/index.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/wifi/index.rst \ No newline at end of file diff --git a/docs/zh_CN/conf.py b/docs/zh_CN/conf.py new file mode 100644 index 0000000000..aee4803d43 --- /dev/null +++ b/docs/zh_CN/conf.py @@ -0,0 +1,320 @@ +# -*- coding: utf-8 -*- +# +# Read the Docs Template documentation build configuration file, created by +# sphinx-quickstart on Tue Aug 26 14:19:49 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os +import re +from subprocess import call, Popen, PIPE +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('.')) + +from repo_util import run_cmd_get_output + +# Call Doxygen to get XML files from the header files +print "Calling Doxygen to generate latest XML files" +call('doxygen') +# Generate 'api_name.inc' files using the XML files by Doxygen +os.system("python gen-dxd.py") +# Generate 'kconfig.inc' file from components' Kconfig files +os.system("python gen-kconfig-doc.py > _build/inc/kconfig.inc") + +# http://stackoverflow.com/questions/12772927/specifying-an-online-image-in-sphinx-restructuredtext-format +# +suppress_warnings = ['image.nonlocal_uri'] + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['breathe', + 'link-roles', + 'sphinxcontrib.blockdiag', + 'sphinxcontrib.seqdiag', + 'sphinxcontrib.actdiag', + 'sphinxcontrib.nwdiag', + 'sphinxcontrib.rackdiag', + 'sphinxcontrib.packetdiag' + ] + +# Set up font for blockdiag, nwdiag, rackdiag and packetdiag +blockdiag_fontpath = '_static/DejaVuSans.ttf' +seqdiag_fontpath = '_static/DejaVuSans.ttf' +actdiag_fontpath = '_static/DejaVuSans.ttf' +nwdiag_fontpath = '_static/DejaVuSans.ttf' +rackdiag_fontpath = '_static/DejaVuSans.ttf' +packetdiag_fontpath = '_static/DejaVuSans.ttf' + +# Breathe extension variables +breathe_projects = { "esp32-idf": "xml/" } +breathe_default_project = "esp32-idf" + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = ['.rst', '.md'] + +source_parsers = { + '.md': 'recommonmark.parser.CommonMarkParser', + } + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'ESP-IDF Programming Guide' +copyright = u'2016 - 2017, Espressif' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# + +# Readthedocs largely ignores 'version' and 'release', and displays one of +# 'latest', tag name, or branch name, depending on the build type. +# Still, this is useful for non-RTD builds. +# This is supposed to be "the short X.Y version", but it's the only version +# visible when you open index.html. +# Display full version to make things less confusing. +version = run_cmd_get_output('git describe') +# The full version, including alpha/beta/rc tags. +# If needed, nearest tag is returned by 'git describe --abbrev=0'. +release = version +print 'Version: {0} Release: {1}'.format(version, release) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build','README.md'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ReadtheDocsTemplatedoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'ReadtheDocsTemplate.tex', u'Read the Docs Template Documentation', + u'Read the Docs', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'readthedocstemplate', u'Read the Docs Template Documentation', + [u'Read the Docs'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'ReadtheDocsTemplate', u'Read the Docs Template Documentation', + u'Read the Docs', 'ReadtheDocsTemplate', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +# -- Use sphinx_rtd_theme for local builds -------------------------------- +# ref. https://github.com/snide/sphinx_rtd_theme#using-this-theme-locally-then-building-on-read-the-docs +# +# on_rtd is whether we are on readthedocs.org +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# otherwise, readthedocs.org uses their theme by default, so no need to specify it + diff --git a/docs/zh_CN/contribute/contributor-agreement.rst b/docs/zh_CN/contribute/contributor-agreement.rst new file mode 100644 index 0000000000..667b9a6a63 --- /dev/null +++ b/docs/zh_CN/contribute/contributor-agreement.rst @@ -0,0 +1 @@ +.. include:: ../../en/contribute/contributor-agreement.rst \ No newline at end of file diff --git a/docs/zh_CN/contribute/documenting-code.rst b/docs/zh_CN/contribute/documenting-code.rst new file mode 100644 index 0000000000..14493ca877 --- /dev/null +++ b/docs/zh_CN/contribute/documenting-code.rst @@ -0,0 +1 @@ +.. include:: ../../en/contribute/documenting-code.rst \ No newline at end of file diff --git a/docs/zh_CN/contribute/index.rst b/docs/zh_CN/contribute/index.rst new file mode 100644 index 0000000000..36e9839920 --- /dev/null +++ b/docs/zh_CN/contribute/index.rst @@ -0,0 +1 @@ +.. include:: ../../en/contribute/index.rst \ No newline at end of file diff --git a/docs/zh_CN/contribute/style-guide.rst b/docs/zh_CN/contribute/style-guide.rst new file mode 100644 index 0000000000..275b9894ce --- /dev/null +++ b/docs/zh_CN/contribute/style-guide.rst @@ -0,0 +1 @@ +.. include:: ../../en/contribute/style-guide.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/add-idf_path-to-profile.rst b/docs/zh_CN/get-started/add-idf_path-to-profile.rst new file mode 100644 index 0000000000..7ece4ab8f6 --- /dev/null +++ b/docs/zh_CN/get-started/add-idf_path-to-profile.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/add-idf_path-to-profile.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/eclipse-setup-windows.rst b/docs/zh_CN/get-started/eclipse-setup-windows.rst new file mode 100644 index 0000000000..2b0be7bd22 --- /dev/null +++ b/docs/zh_CN/get-started/eclipse-setup-windows.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/eclipse-setup-windows.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/eclipse-setup.rst b/docs/zh_CN/get-started/eclipse-setup.rst new file mode 100644 index 0000000000..181724b740 --- /dev/null +++ b/docs/zh_CN/get-started/eclipse-setup.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/eclipse-setup.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/establish-serial-connection.rst b/docs/zh_CN/get-started/establish-serial-connection.rst new file mode 100644 index 0000000000..4cae221a50 --- /dev/null +++ b/docs/zh_CN/get-started/establish-serial-connection.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/establish-serial-connection.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/get-started-devkitc-v2.rst b/docs/zh_CN/get-started/get-started-devkitc-v2.rst new file mode 100644 index 0000000000..ecb30677de --- /dev/null +++ b/docs/zh_CN/get-started/get-started-devkitc-v2.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/get-started-devkitc-v2.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/get-started-devkitc.rst b/docs/zh_CN/get-started/get-started-devkitc.rst new file mode 100644 index 0000000000..522695d65f --- /dev/null +++ b/docs/zh_CN/get-started/get-started-devkitc.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/get-started-devkitc.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/get-started-pico-kit-v3.rst b/docs/zh_CN/get-started/get-started-pico-kit-v3.rst new file mode 100644 index 0000000000..78f066451d --- /dev/null +++ b/docs/zh_CN/get-started/get-started-pico-kit-v3.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/get-started-pico-kit-v3.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/get-started-pico-kit.rst b/docs/zh_CN/get-started/get-started-pico-kit.rst new file mode 100644 index 0000000000..f2adbcf20c --- /dev/null +++ b/docs/zh_CN/get-started/get-started-pico-kit.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/get-started-pico-kit.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/get-started-wrover-kit-v2.rst b/docs/zh_CN/get-started/get-started-wrover-kit-v2.rst new file mode 100644 index 0000000000..88764b0f8e --- /dev/null +++ b/docs/zh_CN/get-started/get-started-wrover-kit-v2.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/get-started-wrover-kit-v2.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/get-started-wrover-kit.rst b/docs/zh_CN/get-started/get-started-wrover-kit.rst new file mode 100644 index 0000000000..50944db789 --- /dev/null +++ b/docs/zh_CN/get-started/get-started-wrover-kit.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/get-started-wrover-kit.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/idf-monitor.rst b/docs/zh_CN/get-started/idf-monitor.rst new file mode 100644 index 0000000000..a3c3f4f17e --- /dev/null +++ b/docs/zh_CN/get-started/idf-monitor.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/idf-monitor.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/index.rst b/docs/zh_CN/get-started/index.rst new file mode 100644 index 0000000000..63ab14f000 --- /dev/null +++ b/docs/zh_CN/get-started/index.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/index.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/linux-setup-scratch.rst b/docs/zh_CN/get-started/linux-setup-scratch.rst new file mode 100644 index 0000000000..be9ac0158b --- /dev/null +++ b/docs/zh_CN/get-started/linux-setup-scratch.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/linux-setup-scratch.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/linux-setup.rst b/docs/zh_CN/get-started/linux-setup.rst new file mode 100644 index 0000000000..3094d0bdf2 --- /dev/null +++ b/docs/zh_CN/get-started/linux-setup.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/linux-setup.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/macos-setup-scratch.rst b/docs/zh_CN/get-started/macos-setup-scratch.rst new file mode 100644 index 0000000000..f80efb8067 --- /dev/null +++ b/docs/zh_CN/get-started/macos-setup-scratch.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/macos-setup-scratch.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/macos-setup.rst b/docs/zh_CN/get-started/macos-setup.rst new file mode 100644 index 0000000000..a0edfdb160 --- /dev/null +++ b/docs/zh_CN/get-started/macos-setup.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/macos-setup.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/make-project.rst b/docs/zh_CN/get-started/make-project.rst new file mode 100644 index 0000000000..e2939c2196 --- /dev/null +++ b/docs/zh_CN/get-started/make-project.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/make-project.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/toolchain-setup-scratch.rst b/docs/zh_CN/get-started/toolchain-setup-scratch.rst new file mode 100644 index 0000000000..43a8920c14 --- /dev/null +++ b/docs/zh_CN/get-started/toolchain-setup-scratch.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/toolchain-setup-scratch.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/windows-setup-scratch.rst b/docs/zh_CN/get-started/windows-setup-scratch.rst new file mode 100644 index 0000000000..6ca82060e8 --- /dev/null +++ b/docs/zh_CN/get-started/windows-setup-scratch.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/windows-setup-scratch.rst \ No newline at end of file diff --git a/docs/zh_CN/get-started/windows-setup.rst b/docs/zh_CN/get-started/windows-setup.rst new file mode 100644 index 0000000000..cd71e5d646 --- /dev/null +++ b/docs/zh_CN/get-started/windows-setup.rst @@ -0,0 +1 @@ +.. include:: ../../en/get-started/windows-setup.rst \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/index.rst b/docs/zh_CN/hw-reference/index.rst new file mode 100644 index 0000000000..f550fa4f81 --- /dev/null +++ b/docs/zh_CN/hw-reference/index.rst @@ -0,0 +1 @@ +.. include:: ../../en/hw-reference/index.rst \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/modules-and-boards-previous.rst b/docs/zh_CN/hw-reference/modules-and-boards-previous.rst new file mode 100644 index 0000000000..30e33d94c9 --- /dev/null +++ b/docs/zh_CN/hw-reference/modules-and-boards-previous.rst @@ -0,0 +1 @@ +.. include:: ../../en/hw-reference/modules-and-boards-previous.rst \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/modules-and-boards.rst b/docs/zh_CN/hw-reference/modules-and-boards.rst new file mode 100644 index 0000000000..311e160fea --- /dev/null +++ b/docs/zh_CN/hw-reference/modules-and-boards.rst @@ -0,0 +1 @@ +.. include:: ../../en/hw-reference/modules-and-boards.rst \ No newline at end of file diff --git a/docs/zh_CN/index.rst b/docs/zh_CN/index.rst new file mode 100644 index 0000000000..58446d485c --- /dev/null +++ b/docs/zh_CN/index.rst @@ -0,0 +1 @@ +.. include:: ../en/index.rst \ No newline at end of file diff --git a/docs/zh_CN/resources.rst b/docs/zh_CN/resources.rst new file mode 100644 index 0000000000..320597ae34 --- /dev/null +++ b/docs/zh_CN/resources.rst @@ -0,0 +1 @@ +.. include:: ../en/resources.rst \ No newline at end of file diff --git a/docs/zh_CN/security/flash-encryption.rst b/docs/zh_CN/security/flash-encryption.rst new file mode 100644 index 0000000000..3d4a739053 --- /dev/null +++ b/docs/zh_CN/security/flash-encryption.rst @@ -0,0 +1 @@ +.. include:: ../../en/security/flash-encryption.rst \ No newline at end of file diff --git a/docs/zh_CN/security/secure-boot.rst b/docs/zh_CN/security/secure-boot.rst new file mode 100644 index 0000000000..8f46c8e4f3 --- /dev/null +++ b/docs/zh_CN/security/secure-boot.rst @@ -0,0 +1 @@ +.. include:: ../../en/security/secure-boot.rst \ No newline at end of file