diff --git a/.gitignore b/.gitignore index 2b5352ff2..ef3b5bdd0 100644 --- a/.gitignore +++ b/.gitignore @@ -26,15 +26,14 @@ examples/**/sdkconfig examples/**/sdkconfig.old examples/**/build -#Doc build artifacts -docs/_build/ -docs/doxygen-warning-log.txt -docs/sphinx-warning-log.txt -docs/sphinx-warning-log-sanitized.txt -docs/xml/ -docs/xml_in/ -docs/man/ -docs/doxygen_sqlite3.db +# Doc build artifacts +docs/*/_build/ +docs/*/doxygen-warning-log.txt +docs/*/sphinx-warning-log.txt +docs/*/sphinx-warning-log-sanitized.txt +docs/*/xml/ +docs/*/xml_in/ +docs/*/man/ # Unit test app files tools/unit-test-app/sdkconfig diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 09711b6b7..ea4323ac1 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -196,19 +196,26 @@ build_docs: artifacts: when: always paths: - - docs/doxygen-warning-log.txt - - docs/sphinx-warning-log.txt - - docs/sphinx-warning-log-sanitized.txt - - docs/_build/html + # English version of documentation + - docs/en/doxygen-warning-log.txt + - docs/en/sphinx-warning-log.txt + - docs/en/sphinx-warning-log-sanitized.txt + - docs/en/_build/html + # Chinese version of documentation + - docs/zh_CN/doxygen-warning-log.txt + - docs/zh_CN/sphinx-warning-log.txt + - docs/zh_CN/sphinx-warning-log-sanitized.txt + - docs/zh_CN/_build/html expire_in: 1 mos script: - - cd docs - - doxygen - # If there are Doxygen warnings, print them and bail out - - test $(cat doxygen-warning-log.txt | wc -l) -eq 0 || ( echo "Doxygen pass had some warnings:" && cat doxygen-warning-log.txt && false ) + - cd docs/en - make gh-linkcheck - make html - - ./check_doc_warnings.sh + - ../check_doc_warnings.sh + - cd ../zh_CN + - make gh-linkcheck + - make html + - ../check_doc_warnings.sh test_nvs_on_host: stage: test @@ -361,7 +368,7 @@ push_master_to_github: deploy_docs: - stage: deploy + stage: assign_test image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG tags: - deploy @@ -381,11 +388,19 @@ deploy_docs: - chmod 600 ~/.ssh/id_rsa - echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config - export GIT_VER=$(git describe --always) - - cd docs/_build/ + - cd docs/en/_build/ - mv html $GIT_VER - tar czvf $GIT_VER.tar.gz $GIT_VER - - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH - - ssh $DOCS_SERVER -x "cd $DOCS_PATH && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest" + - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/en + - ssh $DOCS_SERVER -x "cd $DOCS_PATH/en && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest" + - cd ../../zh_CN/_build/ + - mv html $GIT_VER + - tar czvf $GIT_VER.tar.gz $GIT_VER + - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/zh_CN + - ssh $DOCS_SERVER -x "cd $DOCS_PATH/zh_CN && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest" + # add link to preview doc + - echo "[document preview][en] $CI_DOCKER_REGISTRY/docs/esp-idf/en/${GIT_VER}/index.html" + - echo "[document preview][zh_CN] $CI_DOCKER_REGISTRY/docs/esp-idf/zh_CN/${GIT_VER}/index.html" check_doc_links: stage: test diff --git a/README.md b/README.md index e2bf85ea9..df29f2221 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ The simplest way to use the partition table is to `make menuconfig` and choose o In both cases the factory app is flashed at offset 0x10000. If you `make partition_table` then it will print a summary of the partition table. -For more details about partition tables and how to create custom variations, view the [`docs/api-guides/partition-tables.rst`](docs/api-guides/partition-tables.rst) file. +For more details about partition tables and how to create custom variations, view the [`docs/en/api-guides/partition-tables.rst`](docs/en/api-guides/partition-tables.rst) file. ## Erasing Flash diff --git a/docs/Doxyfile b/docs/Doxyfile index dbc405d23..0eb592737 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -24,146 +24,146 @@ INPUT = \ ## ## Wi-Fi - API Reference ## - ../components/esp32/include/esp_wifi.h \ - ../components/esp32/include/esp_wifi_types.h \ - ../components/esp32/include/esp_smartconfig.h \ - ../components/esp32/include/esp_now.h \ + ../../components/esp32/include/esp_wifi.h \ + ../../components/esp32/include/esp_wifi_types.h \ + ../../components/esp32/include/esp_smartconfig.h \ + ../../components/esp32/include/esp_now.h \ ## Bluetooth - API Reference ## Controller && VHCI - ../components/bt/include/bt.h \ + ../../components/bt/include/bt.h \ ## Bluetooth COMMON ## Issue with __attribute__ - ../components/bt/bluedroid/api/include/esp_bt_defs.h \ - ../components/bt/bluedroid/api/include/esp_bt_main.h \ - ../components/bt/bluedroid/api/include/esp_bt_device.h \ + ../../components/bt/bluedroid/api/include/esp_bt_defs.h \ + ../../components/bt/bluedroid/api/include/esp_bt_main.h \ + ../../components/bt/bluedroid/api/include/esp_bt_device.h \ ## Bluetooth LE - ../components/bt/bluedroid/api/include/esp_gap_ble_api.h \ + ../../components/bt/bluedroid/api/include/esp_gap_ble_api.h \ ## Issue with __attribute__ - ../components/bt/bluedroid/api/include/esp_gatt_defs.h \ - ../components/bt/bluedroid/api/include/esp_gatts_api.h \ - ../components/bt/bluedroid/api/include/esp_gattc_api.h \ - ../components/bt/bluedroid/api/include/esp_blufi_api.h \ + ../../components/bt/bluedroid/api/include/esp_gatt_defs.h \ + ../../components/bt/bluedroid/api/include/esp_gatts_api.h \ + ../../components/bt/bluedroid/api/include/esp_gattc_api.h \ + ../../components/bt/bluedroid/api/include/esp_blufi_api.h \ ## Bluetooth Classic - ../components/bt/bluedroid/api/include/esp_gap_bt_api.h \ + ../../components/bt/bluedroid/api/include/esp_gap_bt_api.h \ ## Issue with __attribute__ - ../components/bt/bluedroid/api/include/esp_a2dp_api.h \ - ../components/bt/bluedroid/api/include/esp_avrc_api.h \ - ../components/bt/bluedroid/api/include/esp_spp_api.h \ + ../../components/bt/bluedroid/api/include/esp_a2dp_api.h \ + ../../components/bt/bluedroid/api/include/esp_avrc_api.h \ + ../../components/bt/bluedroid/api/include/esp_spp_api.h \ ## ## Ethernet - API Reference ## - ../components/ethernet/include/esp_eth.h \ - ../components/ethernet/include/eth_phy/phy.h \ - ../components/ethernet/include/eth_phy/phy_tlk110.h \ - ../components/ethernet/include/eth_phy/phy_lan8720.h \ + ../../components/ethernet/include/esp_eth.h \ + ../../components/ethernet/include/eth_phy/phy.h \ + ../../components/ethernet/include/eth_phy/phy_tlk110.h \ + ../../components/ethernet/include/eth_phy/phy_lan8720.h \ ## ## Peripherals - API Reference ## - ../components/driver/include/driver/adc.h \ - ../components/driver/include/driver/dac.h \ - ../components/driver/include/driver/gpio.h \ - ../components/driver/include/driver/rtc_io.h \ - ../components/driver/include/driver/i2c.h \ - ../components/driver/include/driver/i2s.h \ - ../components/driver/include/driver/ledc.h \ - ../components/driver/include/driver/mcpwm.h \ - ../components/driver/include/driver/pcnt.h \ - ../components/driver/include/driver/rmt.h \ - ../components/driver/include/driver/sigmadelta.h \ - ../components/driver/include/driver/spi_common.h \ - ../components/driver/include/driver/spi_master.h \ - ../components/driver/include/driver/spi_slave.h \ - ../components/driver/include/driver/timer.h \ - ../components/driver/include/driver/touch_pad.h \ - ../components/driver/include/driver/uart.h \ - ../components/esp_adc_cal/include/esp_adc_cal.h \ - ../components/soc/esp32/include/soc/adc_channel.h \ - ../components/soc/esp32/include/soc/dac_channel.h \ - ../components/soc/esp32/include/soc/touch_channel.h \ - ../components/soc/esp32/include/soc/uart_channel.h \ - ../components/soc/esp32/include/soc/rtc_gpio_channel.h \ + ../../components/driver/include/driver/adc.h \ + ../../components/driver/include/driver/dac.h \ + ../../components/driver/include/driver/gpio.h \ + ../../components/driver/include/driver/rtc_io.h \ + ../../components/driver/include/driver/i2c.h \ + ../../components/driver/include/driver/i2s.h \ + ../../components/driver/include/driver/ledc.h \ + ../../components/driver/include/driver/mcpwm.h \ + ../../components/driver/include/driver/pcnt.h \ + ../../components/driver/include/driver/rmt.h \ + ../../components/driver/include/driver/sigmadelta.h \ + ../../components/driver/include/driver/spi_common.h \ + ../../components/driver/include/driver/spi_master.h \ + ../../components/driver/include/driver/spi_slave.h \ + ../../components/driver/include/driver/timer.h \ + ../../components/driver/include/driver/touch_pad.h \ + ../../components/driver/include/driver/uart.h \ + ../../components/esp_adc_cal/include/esp_adc_cal.h \ + ../../components/soc/esp32/include/soc/adc_channel.h \ + ../../components/soc/esp32/include/soc/dac_channel.h \ + ../../components/soc/esp32/include/soc/touch_channel.h \ + ../../components/soc/esp32/include/soc/uart_channel.h \ + ../../components/soc/esp32/include/soc/rtc_gpio_channel.h \ ## ## Protocols - API Reference ## - ../components/mdns/include/mdns.h \ + ../../components/mdns/include/mdns.h \ ## ## Storage - API Reference ## ## SPI Flash and Partition APIs - ../components/spi_flash/include/esp_spi_flash.h \ - ../components/spi_flash/include/esp_partition.h \ - ../components/bootloader_support/include/esp_flash_encrypt.h \ + ../../components/spi_flash/include/esp_spi_flash.h \ + ../../components/spi_flash/include/esp_partition.h \ + ../../components/bootloader_support/include/esp_flash_encrypt.h \ ## SPIFFS - ../components/spiffs/include/esp_spiffs.h \ + ../../components/spiffs/include/esp_spiffs.h \ ## SD/MMC Card Host ## NOTE: for three lines below header_file.inc is not used - ../components/sdmmc/include/sdmmc_cmd.h \ - ../components/driver/include/driver/sdmmc_host.h \ - ../components/driver/include/driver/sdmmc_types.h \ - ../components/driver/include/driver/sdspi_host.h \ + ../../components/sdmmc/include/sdmmc_cmd.h \ + ../../components/driver/include/driver/sdmmc_host.h \ + ../../components/driver/include/driver/sdmmc_types.h \ + ../../components/driver/include/driver/sdspi_host.h \ ## Non-Volatile Storage - ../components/nvs_flash/include/nvs.h \ - ../components/nvs_flash/include/nvs_flash.h \ + ../../components/nvs_flash/include/nvs.h \ + ../../components/nvs_flash/include/nvs_flash.h \ ## Virtual Filesystem - ../components/vfs/include/esp_vfs.h \ - ../components/vfs/include/esp_vfs_dev.h \ + ../../components/vfs/include/esp_vfs.h \ + ../../components/vfs/include/esp_vfs_dev.h \ ## FAT Filesystem ## NOTE: for two lines below header_file.inc is not used - ../components/fatfs/src/esp_vfs_fat.h \ - ../components/fatfs/src/diskio.h \ + ../../components/fatfs/src/esp_vfs_fat.h \ + ../../components/fatfs/src/diskio.h \ ## Wear Levelling - ../components/wear_levelling/include/wear_levelling.h \ + ../../components/wear_levelling/include/wear_levelling.h \ ## ## System - API Reference ## ## Memory Allocation # - ../components/heap/include/esp_heap_caps.h \ - ../components/heap/include/esp_heap_trace.h \ - ../components/heap/include/esp_heap_caps_init.h \ - ../components/heap/include/multi_heap.h \ + ../../components/heap/include/esp_heap_caps.h \ + ../../components/heap/include/esp_heap_trace.h \ + ../../components/heap/include/esp_heap_caps_init.h \ + ../../components/heap/include/multi_heap.h \ ## Interrupt Allocation - ../components/esp32/include/esp_intr_alloc.h \ + ../../components/esp32/include/esp_intr_alloc.h \ ## Watchdogs ## NOTE: for two lines below header_file.inc is not used - ../components/esp32/include/esp_int_wdt.h \ - ../components/esp32/include/esp_task_wdt.h \ + ../../components/esp32/include/esp_int_wdt.h \ + ../../components/esp32/include/esp_task_wdt.h \ ## Hooks - ../components/esp32/include/esp_freertos_hooks.h \ + ../../components/esp32/include/esp_freertos_hooks.h \ ## Inter-Processor Call - ../components/esp32/include/esp_ipc.h \ + ../../components/esp32/include/esp_ipc.h \ ## Over The Air Updates (OTA) - ../components/app_update/include/esp_ota_ops.h \ + ../../components/app_update/include/esp_ota_ops.h \ ## Sleep ## NOTE: for line below header_file.inc is not used - ../components/esp32/include/esp_sleep.h \ + ../../components/esp32/include/esp_sleep.h \ ## Logging - ../components/log/include/esp_log.h \ + ../../components/log/include/esp_log.h \ ## Base MAC address ## NOTE: for line below header_file.inc is not used - ../components/esp32/include/esp_system.h \ + ../../components/esp32/include/esp_system.h \ ## ## ULP Coprocessor - API Guides ## ## NOTE: for line below header_file.inc is not used - ../components/ulp/include/esp32/ulp.h \ + ../../components/ulp/include/esp32/ulp.h \ ## ## Application Level Tracing - API Reference ## - ../components/app_trace/include/esp_app_trace.h \ + ../../components/app_trace/include/esp_app_trace.h \ ### Power management - ../components/esp32/include/esp_pm.h \ - ../components/esp32/include/esp32/pm.h \ + ../../components/esp32/include/esp_pm.h \ + ../../components/esp32/include/esp32/pm.h \ ### esp_timer, High Resolution Timer - ../components/esp32/include/esp_timer.h \ + ../../components/esp32/include/esp_timer.h \ ### ### FreeRTOS ### - ../components/freertos/include/freertos/task.h \ - ../components/freertos/include/freertos/queue.h \ - ../components/freertos/include/freertos/semphr.h \ - ../components/freertos/include/freertos/timers.h \ - ../components/freertos/include/freertos/event_groups.h \ - ../components/freertos/include/freertos/ringbuf.h + ../../components/freertos/include/freertos/task.h \ + ../../components/freertos/include/freertos/queue.h \ + ../../components/freertos/include/freertos/semphr.h \ + ../../components/freertos/include/freertos/timers.h \ + ../../components/freertos/include/freertos/event_groups.h \ + ../../components/freertos/include/freertos/ringbuf.h diff --git a/docs/README.md b/docs/README.md index fc57c4b05..dbd27c900 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,11 +1,18 @@ # Documentation Source Folder -This folder contains source files of [ESP-IDF documentation](https://esp-idf.readthedocs.io/). +This folder contains source files of **ESP-IDF documentation** avialable in [English](https://esp-idf.readthedocs.io/en/latest/) and [中文](https://esp-idf.readthedocs.io/zh_CN/latest/). The sources do not render well in GitHub and some information is not visible at all. -Use actual documentation generated instantly on each commit: +Use actual documentation generated within about 20 minutes on each commit: -* Main server: https://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/ -* Mirror: https://dl.espressif.com/doc/esp-idf/latest/ +## English +* Main server: https://esp-idf.readthedocs.io/en/latest/ or http://esp-idf.readthedocs.io/en/latest/ +* Mirror: https://espressif-docs.readthedocs-hosted.com/projects/esp-idf/en/latest/ +* Latest docs mirror: https://dl.espressif.com/doc/esp-idf/latest/ + +## 中文 + +* Main server: https://esp-idf.readthedocs.io/zh_CN/latest/ or http://esp-idf.readthedocs.io/zh_CN/latest/ +* Mirror: https://espressif-docs.readthedocs-hosted.com/projects/esp-idf/zh_CN/latest/ diff --git a/docs/api-guides/ulp_macros.rst b/docs/api-guides/ulp_macros.rst deleted file mode 100644 index 0a0c5df69..000000000 --- a/docs/api-guides/ulp_macros.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../components/ulp/README.rst \ No newline at end of file diff --git a/docs/check_doc_warnings.sh b/docs/check_doc_warnings.sh index 4107b9929..87bf6b397 100755 --- a/docs/check_doc_warnings.sh +++ b/docs/check_doc_warnings.sh @@ -2,8 +2,7 @@ # # Check for Documentation warnings: # doxygen-warning-log.txt should be an empty file -# sphinx-warning-log.txt should only contain (fuzzy) matches to sphinx-known-warnings.txt -cd "$(dirname $0)" +# sphinx-warning-log.txt should only contain (fuzzy) matches to ../sphinx-known-warnings.txt RESULT=0 STARS='***************************************************' @@ -22,19 +21,19 @@ sed -r 's:\x1B\[[0-9;]*[mK]::g' sphinx-warning-log.txt | \ sed -E "s~${IDF_PATH}~\${IDF_PATH}~" | \ sed -E "s/:[0-9]+:/:line:/" > sphinx-warning-log-sanitized.txt -# diff sanitized warnings, ignoring lines which only appear in sphinx-known-warnings.txt +# diff sanitized warnings, ignoring lines which only appear in ../sphinx-known-warnings.txt # format is to display only lines new or changed in second argument DIFF_FORMAT="--unchanged-line-format= --old-line-format= --new-line-format=%L" -SPHINX_WARNINGS=$(diff $DIFF_FORMAT sphinx-known-warnings.txt sphinx-warning-log-sanitized.txt) +SPHINX_WARNINGS=$(diff $DIFF_FORMAT ../sphinx-known-warnings.txt sphinx-warning-log-sanitized.txt) if ! [ -z "$SPHINX_WARNINGS" ]; then echo "$STARS" echo "Build failed due to new/different Sphinx warnings:" echo "$SPHINX_WARNINGS" echo "$STARS" RESULT=1 - echo "(Check files sphinx-known-warnings.txt and sphinx-warning-log.txt for full details.)" + echo "(Check files ../sphinx-known-warnings.txt and sphinx-warning-log.txt for full details.)" fi exit $RESULT diff --git a/docs/contribute/index.rst b/docs/contribute/index.rst deleted file mode 100644 index ac7b6bcf3..000000000 --- a/docs/contribute/index.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CONTRIBUTING.rst 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 95% rename from docs/about.rst rename to docs/en/about.rst index 235161892..2c4606756 100644 --- a/docs/about.rst +++ b/docs/en/about.rst @@ -5,7 +5,7 @@ This is documentation of `ESP-IDF `_, the The ESP32 is 2.4 GHz Wi-Fi and Bluetooth combo, 32 bit dual core chip with 600 DMIPS processing power. -.. figure:: _static/about-doc.png +.. figure:: ../_static/about-doc.png :align: center :alt: Espressif IoT Integrated Development Framework :figclass: align-center 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 99% rename from docs/api-guides/app_trace.rst rename to docs/en/api-guides/app_trace.rst index bdc1f5d33..53ff5b295 100644 --- a/docs/api-guides/app_trace.rst +++ b/docs/en/api-guides/app_trace.rst @@ -15,7 +15,7 @@ Developers can use this library to send application specific state of execution Tracing components when working over JTAG interface are shown in the figure below. -.. figure:: ../_static/app_trace-overview.jpg +.. figure:: ../../_static/app_trace-overview.jpg :align: center :alt: Tracing Components when Working Over JTAG :figclass: align-center 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 99% rename from docs/api-guides/freertos-smp.rst rename to docs/en/api-guides/freertos-smp.rst index e1763bf59..9851929af 100644 --- a/docs/api-guides/freertos-smp.rst +++ b/docs/en/api-guides/freertos-smp.rst @@ -208,7 +208,7 @@ where each element of the array is a linked list. Each linked list is of type Ready state. The following diagram illustrates the ``pxReadyTasksList`` structure. -.. figure:: ../_static/freertos-ready-task-list.png +.. figure:: ../../_static/freertos-ready-task-list.png :align: center :alt: Vanilla FreeRTOS Ready Task List Structure @@ -226,7 +226,7 @@ calls the scheduler, it is able to look at the ``xCoreID`` member of each TCB in the list to determine if a task is allowed to run on calling the core. The ESP-IDF FreeRTOS ``pxReadyTasksList`` is illustrated below. -.. figure:: ../_static/freertos-ready-task-list-smp.png +.. figure:: ../../_static/freertos-ready-task-list-smp.png :align: center :alt: ESP-IDF FreeRTOS Ready Task List Structure @@ -246,7 +246,7 @@ the previous scheduler call from the other core would not be considered on the current scheduler call. This issue is demonstrated in the following illustration. -.. figure:: ../_static/freertos-ready-task-list-smp-pxIndex.png +.. figure:: ../../_static/freertos-ready-task-list-smp-pxIndex.png :align: center :alt: ESP-IDF pxIndex Behavior 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 99% rename from docs/api-guides/jtag-debugging/configure-wrover.rst rename to docs/en/api-guides/jtag-debugging/configure-wrover.rst index 6b1d40cf5..95e693214 100644 --- a/docs/api-guides/jtag-debugging/configure-wrover.rst +++ b/docs/en/api-guides/jtag-debugging/configure-wrover.rst @@ -47,7 +47,7 @@ Windows 5. Check the list of devices that should contain two WROVER specific USB entries: "Dual RS232-HS (Interface 0)" and "Dual RS232-HS (Interface 1)". The driver name would be "FTDIBUS (vxxxx)" and USB ID: 0403 6010. - .. figure:: ../../_static/jtag-usb-configuration-zadig.jpg + .. figure:: ../../../_static/jtag-usb-configuration-zadig.jpg :align: center :alt: Configuration of JTAG USB driver in Zadig tool :figclass: align-center diff --git a/docs/api-guides/jtag-debugging/debugging-examples.rst b/docs/en/api-guides/jtag-debugging/debugging-examples.rst similarity index 97% rename from docs/api-guides/jtag-debugging/debugging-examples.rst rename to docs/en/api-guides/jtag-debugging/debugging-examples.rst index 6aaa298ec..067a3740c 100644 --- a/docs/api-guides/jtag-debugging/debugging-examples.rst +++ b/docs/en/api-guides/jtag-debugging/debugging-examples.rst @@ -12,7 +12,7 @@ Eclipse Verify if your target is ready and loaded with :example:`get-started/blink` example. Configure and start debugger following steps in section :ref:`jtag-debugging-using-debugger-eclipse`. Pick up where target was left by debugger, i.e. having the application halted at breakpoint established at ``app_main()``. -.. figure:: ../../_static/debug-perspective.jpg +.. figure:: ../../../_static/debug-perspective.jpg :align: center :alt: Debug Perspective in Eclipse :figclass: align-center @@ -39,7 +39,7 @@ Navigating though the code, call stack and threads When the target is halted, debugger shows the list of threads in "Debug" window. The line of code where program halted is highlighted in another window below, as shown on the following picture. The LED stops blinking. -.. figure:: ../../_static/debugging-target-halted.jpg +.. figure:: ../../../_static/debugging-target-halted.jpg :align: center :alt: Target halted during debugging :figclass: align-center @@ -50,7 +50,7 @@ Specific thread where the program halted is expanded showing the call stack. It By expanding threads you can navigate throughout the application. Expand Thread #5 that contains much longer call stack. You will see there, besides function calls, numbers like ``0x4000000c``. They represent addresses of binary code not provided in source form. -.. figure:: ../../_static/debugging-navigate-through-the-stack.jpg +.. figure:: ../../../_static/debugging-navigate-through-the-stack.jpg :align: center :alt: Navigate through the call stack :figclass: align-center @@ -71,7 +71,7 @@ When debugging, we would like to be able to stop the application at critical lin Let's establish two breakpoints when the state of LED changes. Basing on code listing above, this happens at lines 33 and 36. To do so, hold the "Control" on the keyboard and double clink on number ``33`` in file ``blink.c`` file. A dialog will open where you can confirm your selection by pressing "OK" button. If you do not like to see the dialog just double click the line number. Set another breakpoint in line 36. -.. figure:: ../../_static/debugging-setting-breakpoint.jpg +.. figure:: ../../../_static/debugging-setting-breakpoint.jpg :align: center :alt: Setting a breakpoint :figclass: align-center @@ -80,7 +80,7 @@ Let's establish two breakpoints when the state of LED changes. Basing on code li Information how many breakpoints are set and where is shown in window "Breakpoints" on top right. Click "Show Breakpoints Supported by Selected Target" to refresh this list. Besides the two just set breakpoints the list may contain temporary breakpoint at function ``app_main()`` established at debugger start. As maximum two breakpoints are allowed (see :ref:`jtag-debugging-tip-breakpoints`), you need to delete it, or debugging will fail. -.. figure:: ../../_static/debugging-three-breakpoints-set.jpg +.. figure:: ../../../_static/debugging-three-breakpoints-set.jpg :align: center :alt: Three breakpoints are set / maximum two are allowed :figclass: align-center @@ -103,7 +103,7 @@ When debugging, you may resume application and enter code waiting for some event To check it, delete all breakpoints and click "Resume". Then click "Suspend". Application will be halted at some random point and LED will stop blinking. Debugger will expand tread and highlight the line of code where application halted. -.. figure:: ../../_static/debugging-target-halted-manually.jpg +.. figure:: ../../../_static/debugging-target-halted-manually.jpg :align: center :alt: Target halted manually :figclass: align-center @@ -124,7 +124,7 @@ Before being able to demonstrate this functionality, using information discussed Resume program by entering pressing F8 and let it halt. Now press "Step Over (F6)", one by one couple of times, to see how debugger is stepping one program line at a time. -.. figure:: ../../_static/debugging-step-over.jpg +.. figure:: ../../../_static/debugging-step-over.jpg :align: center :alt: Stepping through the code with "Step Over (F6)" :figclass: align-center @@ -133,7 +133,7 @@ Resume program by entering pressing F8 and let it halt. Now press "Step Over (F6 If you press "Step Into (F5)" instead, then debugger will step inside subroutine calls. -.. figure:: ../../_static/debugging-step-into.jpg +.. figure:: ../../../_static/debugging-step-into.jpg :align: center :alt: Stepping through the code with "Step Into (F5)" :figclass: align-center @@ -158,7 +158,7 @@ Being in the same ``blink.c`` project as before, set two breakpoints right after Now resume program by pressing F8 and observe "Monitor" tab. -.. figure:: ../../_static/debugging-memory-location-on.jpg +.. figure:: ../../../_static/debugging-memory-location-on.jpg :align: center :alt: Observing memory location 0x3FF44004 changing one bit to ON" :figclass: align-center @@ -167,7 +167,7 @@ Now resume program by pressing F8 and observe "Monitor" tab. You should see one bit being flipped over at memory location ``0x3FF44004`` (and LED changing the state) each time F8 is pressed. -.. figure:: ../../_static/debugging-memory-location-off.jpg +.. figure:: ../../../_static/debugging-memory-location-off.jpg :align: center :alt: Observing memory location 0x3FF44004 changing one bit to ON" :figclass: align-center @@ -192,7 +192,7 @@ In next step, in the window with "Breakpoints", click the "Expressions" tab. If Resume program execution by pressing F8. Each time the program is halted you will see ``i`` value being incremented. -.. figure:: ../../_static/debugging-watch-variable.jpg +.. figure:: ../../../_static/debugging-watch-variable.jpg :align: center :alt: Watching program variable "i" :figclass: align-center @@ -210,7 +210,7 @@ Setting conditional breakpoints Here comes more interesting part. You may set a breakpoint to halt the program execution, if certain condition is satisfied. Right click on the breakpoint to open a context menu and select "Breakpoint Properties". Change the selection under "Type:" to "Hardware" and enter a "Condition:" like ``i == 2``. -.. figure:: ../../_static/debugging-setting-conditional-breakpoint.jpg +.. figure:: ../../../_static/debugging-setting-conditional-breakpoint.jpg :align: center :alt: Setting a conditional breakpoint :figclass: align-center diff --git a/docs/api-guides/jtag-debugging/index.rst b/docs/en/api-guides/jtag-debugging/index.rst similarity index 98% rename from docs/api-guides/jtag-debugging/index.rst rename to docs/en/api-guides/jtag-debugging/index.rst index a1832029b..65f2e1518 100644 --- a/docs/api-guides/jtag-debugging/index.rst +++ b/docs/en/api-guides/jtag-debugging/index.rst @@ -48,7 +48,7 @@ How it Works? The key software and hardware to perform debugging of ESP32 with OpenOCD over JTAG (Joint Test Action Group) interface is presented below and includes **xtensa-esp32-elf-gdb debugger**, **OpenOCD on chip debugger** and **JTAG adapter** connected to **ESP32** target. -.. figure:: ../../_static/jtag-debugging-overview.jpg +.. figure:: ../../../_static/jtag-debugging-overview.jpg :align: center :alt: JTAG debugging - overview diagram :figclass: align-center @@ -100,13 +100,13 @@ Pick up your OS below and follow provided instructions to setup OpenOCD. | `Windows`_ | `Linux`_ | `Mac OS`_ | +-------------------+-------------------+-------------------+ -.. |windows-logo| image:: ../../_static/windows-logo.png +.. |windows-logo| image:: ../../../_static/windows-logo.png :target: ../jtag-debugging/setup-openocd-windows.html -.. |linux-logo| image:: ../../_static/linux-logo.png +.. |linux-logo| image:: ../../../_static/linux-logo.png :target: ../jtag-debugging/setup-openocd-linux.html -.. |macos-logo| image:: ../../_static/macos-logo.png +.. |macos-logo| image:: ../../../_static/macos-logo.png :target: ../jtag-debugging/setup-openocd-macos.html .. _Windows: ../jtag-debugging/setup-openocd-windows.html 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 97% rename from docs/api-guides/jtag-debugging/using-debugger.rst rename to docs/en/api-guides/jtag-debugging/using-debugger.rst index 72151ae08..e42210aed 100644 --- a/docs/api-guides/jtag-debugging/using-debugger.rst +++ b/docs/en/api-guides/jtag-debugging/using-debugger.rst @@ -28,7 +28,7 @@ Once installation is complete, configure debugging session following steps below A sample window with settings entered in points 1 - 5 is shown below. - .. figure:: ../../_static/hw-debugging-main-tab.jpg + .. figure:: ../../../_static/hw-debugging-main-tab.jpg :align: center :alt: Configuration of GDB Hardware Debugging - Main tab :figclass: align-center @@ -41,7 +41,7 @@ Once installation is complete, configure debugging session following steps below Configuration entered in points 6 and 7 is shown on the following picture. - .. figure:: ../../_static/hw-debugging-debugger-tab.jpg + .. figure:: ../../../_static/hw-debugging-debugger-tab.jpg :align: center :alt: Configuration of GDB Hardware Debugging - Debugger tab :figclass: align-center @@ -67,7 +67,7 @@ Once installation is complete, configure debugging session following steps below Configuration described in points 8 - 11 is shown below. - .. figure:: ../../_static/hw-debugging-startup-tab.jpg + .. figure:: ../../../_static/hw-debugging-startup-tab.jpg :align: center :alt: Configuration of GDB Hardware Debugging - Startup tab :figclass: align-center @@ -80,7 +80,7 @@ Once installation is complete, configure debugging session following steps below Once all 1 - 12 configuration steps are satisfied, the new Eclipse perspective called "Debug" will open as shown on example picture below. -.. figure:: ../../_static/debug-perspective.jpg +.. figure:: ../../../_static/debug-perspective.jpg :align: center :alt: Debug Perspective in Eclipse :figclass: align-center 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/thread-local-storage.rst b/docs/en/api-guides/thread-local-storage.rst similarity index 100% rename from docs/api-guides/thread-local-storage.rst rename to docs/en/api-guides/thread-local-storage.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/en/api-guides/ulp_macros.rst b/docs/en/api-guides/ulp_macros.rst new file mode 100644 index 000000000..9859dcc92 --- /dev/null +++ b/docs/en/api-guides/ulp_macros.rst @@ -0,0 +1 @@ +.. include:: ../../../components/ulp/README.rst \ No newline at end of file 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 98% rename from docs/api-reference/peripherals/adc.rst rename to docs/en/api-reference/peripherals/adc.rst index 3ac2b1754..6b17048dc 100644 --- a/docs/api-reference/peripherals/adc.rst +++ b/docs/en/api-reference/peripherals/adc.rst @@ -90,7 +90,7 @@ Minimizing Noise The ESP32 ADC can be sensitive to noise leading to large discrepancies in ADC readings. To minimize noise, users may connect a 0.1uF capacitor to the ADC input pad in use. Multisampling may also be used to further mitigate the effects of noise. -.. figure:: ../../_static/adc-noise-graph.jpg +.. figure:: ../../../_static/adc-noise-graph.jpg :align: center :alt: ADC noise mitigation @@ -101,7 +101,7 @@ ADC Calibration The :component_file:`esp_adc_cal/include/esp_adc_cal.h` API provides functions to correct for differences in measured voltages caused by variation of ADC reference voltages (Vref) between chips. Per design the ADC reference voltage is 1100mV, however the true reference voltage can range from 1000mV to 1200mV amongst different ESP32s. -.. figure:: ../../_static/adc-vref-graph.jpg +.. figure:: ../../../_static/adc-vref-graph.jpg :align: center :alt: ADC reference voltage comparison 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 99% rename from docs/api-reference/peripherals/ledc.rst rename to docs/en/api-reference/peripherals/ledc.rst index 9b22f1b5d..fe17cc425 100644 --- a/docs/api-reference/peripherals/ledc.rst +++ b/docs/en/api-reference/peripherals/ledc.rst @@ -22,7 +22,7 @@ Getting LEDC to work on specific channel in either :ref:`high or low speed mode In an optional step it is also possible to set up an interrupt on the fade end. -.. figure:: ../../_static/ledc-api-settings.jpg +.. figure:: ../../../_static/ledc-api-settings.jpg :align: center :alt: Key Settings of LED PWM Controller's API :figclass: align-center 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 97% rename from docs/api-reference/peripherals/rmt.rst rename to docs/en/api-reference/peripherals/rmt.rst index 359344a76..74df23fdc 100644 --- a/docs/api-reference/peripherals/rmt.rst +++ b/docs/en/api-reference/peripherals/rmt.rst @@ -23,13 +23,13 @@ The signal, which consists of a series of pulses, is generated by RMT's transmit a [style=none, width=100, label="{11,high,7,low},\n{5,high,5,low},\n..."] b [label="Waveform\nGenerator"] - c [style=none, label="", background="_static/rmt-waveform.png"] + c [style=none, label="", background="../_static/rmt-waveform.png"] d [shape=beginpoint, label="mod"] e [style=none, width=60, height=40, label="Carrier\nenable"] f [label="Carrier\nGenerator"] - g [style=none, label="", background="_static/rmt-carrier.png"] + g [style=none, label="", background="../_static/rmt-carrier.png"] h [shape=none] - o [style=none, label="", background="_static/rmt-waveform-modulated.png"] + o [style=none, label="", background="../_static/rmt-waveform-modulated.png"] group { label = Input @@ -63,7 +63,7 @@ The reverse operation is performed by the receiver, where a series of pulses is e -- f; f -> b [folded]; - a [style=none, label="", background="_static/rmt-waveform.png"] + a [style=none, label="", background="../_static/rmt-waveform.png"] b [label=Filter] c [label="Edge\nDetect"] d [style=none, width=100, label="{11,high,7,low},\n{5,high,5,low},\n..."] 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 99% rename from docs/api-reference/peripherals/touch_pad.rst rename to docs/en/api-reference/peripherals/touch_pad.rst index f56a13fe3..9d407bb56 100644 --- a/docs/api-reference/peripherals/touch_pad.rst +++ b/docs/en/api-reference/peripherals/touch_pad.rst @@ -77,7 +77,7 @@ The following summarizes available measurement parameters and corresponding 'set Relationship between voltage range (high / low reference voltages), speed (slope) and measure time is shown on figure below. -.. figure:: ../../_static/touch_pad-measurement-parameters.jpg +.. figure:: ../../../_static/touch_pad-measurement-parameters.jpg :align: center :alt: Touch Pad - relationship between measurement parameters :figclass: align-center 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 95% rename from docs/api-reference/storage/nvs_flash.rst rename to docs/en/api-reference/storage/nvs_flash.rst index 005b9b04f..184daff12 100644 --- a/docs/api-reference/storage/nvs_flash.rst +++ b/docs/en/api-reference/storage/nvs_flash.rst @@ -1,4 +1,4 @@ -.. include:: ../../../components/nvs_flash/README.rst +.. include:: ../../../../components/nvs_flash/README.rst Application Example ------------------- 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 97% rename from docs/api-reference/storage/spi_flash.rst rename to docs/en/api-reference/storage/spi_flash.rst index 655e9a07d..1dbb92bdd 100644 --- a/docs/api-reference/storage/spi_flash.rst +++ b/docs/en/api-reference/storage/spi_flash.rst @@ -1,4 +1,4 @@ -.. include:: ../../../components/spi_flash/README.rst +.. include:: ../../../../components/spi_flash/README.rst See also -------- 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 65% rename from docs/api-reference/storage/vfs.rst rename to docs/en/api-reference/storage/vfs.rst index c59177cde..78c94230f 100644 --- a/docs/api-reference/storage/vfs.rst +++ b/docs/en/api-reference/storage/vfs.rst @@ -1,11 +1,11 @@ -.. include:: ../../../components/vfs/README.rst +.. include:: ../../../../components/vfs/README.rst Application Example ------------------- `Instructions`_ -.. _Instructions: ../template.html +.. _Instructions: ../../template.html API Reference ------------- diff --git a/docs/api-reference/storage/wear-levelling.rst b/docs/en/api-reference/storage/wear-levelling.rst similarity index 90% rename from docs/api-reference/storage/wear-levelling.rst rename to docs/en/api-reference/storage/wear-levelling.rst index a1306bcf7..ff4055538 100644 --- a/docs/api-reference/storage/wear-levelling.rst +++ b/docs/en/api-reference/storage/wear-levelling.rst @@ -1,4 +1,4 @@ -.. include:: ../../../components/wear_levelling/README.rst +.. include:: ../../../../components/wear_levelling/README.rst See also -------- 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 90% rename from docs/api-reference/system/log.rst rename to docs/en/api-reference/system/log.rst index c9883693c..bcfe0f542 100644 --- a/docs/api-reference/system/log.rst +++ b/docs/en/api-reference/system/log.rst @@ -1,4 +1,4 @@ -.. include:: ../../../components/log/README.rst +.. include:: ../../../../components/log/README.rst Application Example ------------------- 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 95% rename from docs/conf.py rename to docs/en/conf.py index a2cafdbf0..7031188b9 100644 --- a/docs/conf.py +++ b/docs/en/conf.py @@ -14,13 +14,13 @@ import sys, os import re -from subprocess import call, Popen, PIPE +from subprocess import 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('.')) +sys.path.insert(0, os.path.abspath('..')) from local_util import run_cmd_get_output, copy_if_modified @@ -30,17 +30,17 @@ if 'BUILDDIR' in os.environ: # Call Doxygen to get XML files from the header files print "Calling Doxygen to generate latest XML files" -call('doxygen') +os.system("doxygen ../Doxyfile") # Doxygen has generated XML files in 'xml' directory. # Copy them to 'xml_in', only touching the files which have changed. copy_if_modified('xml/', 'xml_in/') # Generate 'api_name.inc' files using the XML files by Doxygen -os.system('python gen-dxd.py') +os.system('python ../gen-dxd.py') # Generate 'kconfig.inc' file from components' Kconfig files kconfig_inc_path = '{}/inc/kconfig.inc'.format(builddir) -os.system('python gen-kconfig-doc.py > ' + kconfig_inc_path + '.in') +os.system('python ../gen-kconfig-doc.py > ' + kconfig_inc_path + '.in') copy_if_modified(kconfig_inc_path + '.in', kconfig_inc_path) # http://stackoverflow.com/questions/12772927/specifying-an-online-image-in-sphinx-restructuredtext-format @@ -66,12 +66,12 @@ extensions = ['breathe', ] # 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' +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 @@ -120,7 +120,7 @@ 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 +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -190,7 +190,7 @@ html_theme = 'default' # 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'] +#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 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 98% rename from docs/contribute/documenting-code.rst rename to docs/en/contribute/documenting-code.rst index 588416dff..37f71deeb 100644 --- a/docs/contribute/documenting-code.rst +++ b/docs/en/contribute/documenting-code.rst @@ -17,7 +17,7 @@ Doxygen is phrasing the code, extracting the commands together with subsequent t Typical comment block, that contains documentation of a function, looks like below. -.. image:: ../_static/doc-code-documentation-inline.png +.. image:: ../../_static/doc-code-documentation-inline.png :align: center :alt: Sample inline code documentation @@ -31,7 +31,7 @@ The ultimate goal is to ensure that all the code is consistently documented, so With these tools the above piece of code renders like below: -.. image:: ../_static/doc-code-documentation-rendered.png +.. image:: ../../_static/doc-code-documentation-rendered.png :align: center :alt: Sample inline code after rendering @@ -47,19 +47,19 @@ When writing code for this repository, please follow guidelines below. 3. Do not add a data type before parameter or any other characters besides spaces. All spaces and line breaks are compressed into a single space. If you like to break a line, then break it twice. - .. image:: ../_static/doc-code-function.png + .. image:: ../../_static/doc-code-function.png :align: center :alt: Sample function documented inline and after rendering 4. If function has void input or does not return any value, then skip ``@param`` or ``@return`` - .. image:: ../_static/doc-code-void-function.png + .. image:: ../../_static/doc-code-void-function.png :align: center :alt: Sample void function documented inline and after rendering 5. When documenting a ``define`` as well as members of a ``struct`` or ``enum``, place specific comment like below after each member. - .. image:: ../_static/doc-code-member.png + .. image:: ../../_static/doc-code-member.png :align: center :alt: Sample of member documentation inline and after rendering diff --git a/docs/en/contribute/index.rst b/docs/en/contribute/index.rst new file mode 100644 index 000000000..b1cd2f37d --- /dev/null +++ b/docs/en/contribute/index.rst @@ -0,0 +1 @@ +.. include:: ../../../CONTRIBUTING.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 95% rename from docs/get-started/establish-serial-connection.rst rename to docs/en/get-started/establish-serial-connection.rst index 929fe1ec2..d8753a6bb 100644 --- a/docs/get-started/establish-serial-connection.rst +++ b/docs/en/get-started/establish-serial-connection.rst @@ -25,14 +25,14 @@ Check the list of identified COM ports in the Windows Device Manager. Disconnect Figures below show serial port for ESP32 DevKitC and ESP32 WROVER KIT -.. figure:: ../_static/esp32-devkitc-in-device-manager.png +.. figure:: ../../_static/esp32-devkitc-in-device-manager.png :align: center :alt: USB to UART bridge of ESP32-DevKitC in Windows Device Manager :figclass: align-center USB to UART bridge of ESP32-DevKitC in Windows Device Manager -.. figure:: ../_static/esp32-wrover-kit-in-device-manager.png +.. figure:: ../../_static/esp32-wrover-kit-in-device-manager.png :align: center :alt: Two USB Serial Ports of ESP-WROVER-KIT in Windows Device Manager :figclass: align-center @@ -73,14 +73,14 @@ Now verify that the serial connection is operational. You can do this using a se Run terminal, set identified serial port, baud rate = 115200, data bits = 8, stop bits = 1, and parity = N. Below are example screen shots of setting the port and such transmission parameters (in short described as 115200-8-1-N) on Windows and Linux. Remember to select exactly the same serial port you have identified in steps above. -.. figure:: ../_static/putty-settings-windows.png +.. figure:: ../../_static/putty-settings-windows.png :align: center :alt: Setting Serial Communication in PuTTY on Windows :figclass: align-center Setting Serial Communication in PuTTY on Windows -.. figure:: ../_static/putty-settings-linux.png +.. figure:: ../../_static/putty-settings-linux.png :align: center :alt: Setting Serial Communication in PuTTY on Linux :figclass: align-center diff --git a/docs/get-started/get-started-devkitc-v2.rst b/docs/en/get-started/get-started-devkitc-v2.rst similarity index 95% rename from docs/get-started/get-started-devkitc-v2.rst rename to docs/en/get-started/get-started-devkitc-v2.rst index 8303c0d15..9d0008679 100644 --- a/docs/get-started/get-started-devkitc-v2.rst +++ b/docs/en/get-started/get-started-devkitc-v2.rst @@ -36,7 +36,7 @@ I/O .. _get-started-esp32-devkitc-v2-board-front: -.. figure:: ../_static/esp32-devkitc-v2-functional-overview.png +.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png :align: center :alt: ESP32-DevKitC V2 board layout :figclass: align-center diff --git a/docs/get-started/get-started-devkitc.rst b/docs/en/get-started/get-started-devkitc.rst similarity index 95% rename from docs/get-started/get-started-devkitc.rst rename to docs/en/get-started/get-started-devkitc.rst index 31e715488..903309762 100644 --- a/docs/get-started/get-started-devkitc.rst +++ b/docs/en/get-started/get-started-devkitc.rst @@ -53,7 +53,7 @@ I/O .. _get-started-esp32-devkitc-board-front: -.. figure:: ../_static/esp32-devkitc-functional-overview.jpg +.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg :align: center :alt: ESP32-DevKitC V4 with ESP-WROOM-32 module soldered :figclass: align-center @@ -91,7 +91,7 @@ To start development of applications, proceed to section :doc:`index`, that will Board Dimensions ---------------- -.. figure:: ../_static/esp32-devkitc-dimensions-back.jpg +.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg :align: center :alt: ESP32 DevKitC board dimensions - back :figclass: align-center 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 96% rename from docs/get-started/get-started-pico-kit-v3.rst rename to docs/en/get-started/get-started-pico-kit-v3.rst index 334c22fad..42325761d 100644 --- a/docs/get-started/get-started-pico-kit-v3.rst +++ b/docs/en/get-started/get-started-pico-kit-v3.rst @@ -36,7 +36,7 @@ EN Button BOOT Button Holding down the Boot button and pressing the EN button initiates the firmware download mode. Then user can download firmware through the serial port. -.. figure:: ../_static/esp32-pico-kit-v3-layout.jpg +.. figure:: ../../_static/esp32-pico-kit-v3-layout.jpg :align: center :alt: ESP32-PICO-KIT V3 board layout :figclass: align-center diff --git a/docs/get-started/get-started-pico-kit.rst b/docs/en/get-started/get-started-pico-kit.rst similarity index 96% rename from docs/get-started/get-started-pico-kit.rst rename to docs/en/get-started/get-started-pico-kit.rst index c0f5e5636..831de1ac1 100644 --- a/docs/get-started/get-started-pico-kit.rst +++ b/docs/en/get-started/get-started-pico-kit.rst @@ -29,7 +29,7 @@ For easy interfacing, all the IO signals and system power on ESP32-PICO-D4 are l The board dimensions are 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4"), see section `Board Dimensions`_. An overview functional block diagram is shown below. -.. figure:: ../_static/esp32-pico-kit-v4-functional-block-diagram.png +.. figure:: ../../_static/esp32-pico-kit-v4-functional-block-diagram.png :align: center :alt: ESP32-PICO-KIT V4 functional block diagram :figclass: align-center @@ -61,7 +61,7 @@ EN Button .. _get-started-pico-kit-v4-board-front: -.. figure:: ../_static/esp32-pico-kit-v4-layout.jpg +.. figure:: ../../_static/esp32-pico-kit-v4-layout.jpg :align: center :alt: ESP32-PICO-KIT V4 board layout :figclass: align-center @@ -182,14 +182,14 @@ No. Name Type Function Board Dimensions ---------------- -.. figure:: ../_static/esp32-pico-kit-v4-dimensions-back.jpg +.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-back.jpg :align: center :alt: ESP32-PICO-KIT V4 dimensions - back :figclass: align-center ESP32-PICO-KIT V4 dimensions - back -.. figure:: ../_static/esp32-pico-kit-v4-dimensions-side.jpg +.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-side.jpg :align: center :alt: ESP32-PICO-KIT V4 dimensions - side :figclass: align-center 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 94% rename from docs/get-started/get-started-wrover-kit-v2.rst rename to docs/en/get-started/get-started-wrover-kit-v2.rst index 5319827a0..c2cc7cb2a 100644 --- a/docs/get-started/get-started-wrover-kit-v2.rst +++ b/docs/en/get-started/get-started-wrover-kit-v2.rst @@ -29,7 +29,7 @@ Functionality Overview Block diagram below presents main components of ESP-WROVER-KIT and interconnections between components. -.. figure:: ../_static/esp32-wrover-kit-block-diagram.png +.. figure:: ../../_static/esp32-wrover-kit-block-diagram.png :align: center :alt: ESP-WROVER-KIT block diagram :figclass: align-center @@ -89,7 +89,7 @@ Micro SD Card LCD ESP-WROVER-KIT supports mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`esp-wrover-kit-v2-board-back`. -.. figure:: ../_static/esp-wrover-kit-v2-layout-front.png +.. figure:: ../../_static/esp-wrover-kit-v2-layout-front.png :align: center :alt: ESP-WROVER-KIT board layout - front :figclass: align-center @@ -98,7 +98,7 @@ LCD .. _esp-wrover-kit-v2-board-back: -.. figure:: ../_static/esp-wrover-kit-v2-layout-back.png +.. figure:: ../../_static/esp-wrover-kit-v2-layout-back.png :align: center :alt: ESP-WROVER-KIT board layout - back :figclass: align-center @@ -180,12 +180,12 @@ Related Documents * :doc:`../hw-reference/index` -.. |jp1-sd_io2| image:: ../_static/wrover-jp1-sd_io2.png -.. |jp1-both| image:: ../_static/wrover-jp1-both.png -.. |jp7-ext_5v| image:: ../_static/wrover-jp7-ext_5v.png -.. |jp7-usb_5v| image:: ../_static/wrover-jp7-usb_5v.png -.. |jp8| image:: ../_static/wrover-jp8.png -.. |jp11-rx-tx| image:: ../_static/wrover-jp11-tx-rx.png -.. |jp14| image:: ../_static/wrover-jp14.png +.. |jp1-sd_io2| image:: ../../_static/wrover-jp1-sd_io2.png +.. |jp1-both| image:: ../../_static/wrover-jp1-both.png +.. |jp7-ext_5v| image:: ../../_static/wrover-jp7-ext_5v.png +.. |jp7-usb_5v| image:: ../../_static/wrover-jp7-usb_5v.png +.. |jp8| image:: ../../_static/wrover-jp8.png +.. |jp11-rx-tx| image:: ../../_static/wrover-jp11-tx-rx.png +.. |jp14| image:: ../../_static/wrover-jp14.png .. _ESP-WROVER-KIT V2 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf diff --git a/docs/get-started/get-started-wrover-kit.rst b/docs/en/get-started/get-started-wrover-kit.rst similarity index 94% rename from docs/get-started/get-started-wrover-kit.rst rename to docs/en/get-started/get-started-wrover-kit.rst index f13dffff4..07de495bf 100644 --- a/docs/get-started/get-started-wrover-kit.rst +++ b/docs/en/get-started/get-started-wrover-kit.rst @@ -29,7 +29,7 @@ Functionality Overview Block diagram below presents main components of ESP-WROVER-KIT and interconnections between components. -.. figure:: ../_static/esp32-wrover-kit-block-diagram.png +.. figure:: ../../_static/esp32-wrover-kit-block-diagram.png :align: center :alt: ESP-WROVER-KIT block diagram :figclass: align-center @@ -90,7 +90,7 @@ LCD .. _get-started-esp-wrover-kit-board-front: -.. figure:: ../_static/esp32-wrover-kit-layout-front.jpg +.. figure:: ../../_static/esp32-wrover-kit-layout-front.jpg :align: center :alt: ESP-WROVER-KIT board layout - front :figclass: align-center @@ -99,7 +99,7 @@ LCD .. _get-started-esp-wrover-kit-board-back: -.. figure:: ../_static/esp32-wrover-kit-layout-back.jpg +.. figure:: ../../_static/esp32-wrover-kit-layout-back.jpg :align: center :alt: ESP-WROVER-KIT board layout - back :figclass: align-center @@ -399,13 +399,13 @@ Related Documents * :doc:`../hw-reference/index` -.. |jp1-sd_io2| image:: ../_static/wrover-jp1-sd_io2.png -.. |jp1-both| image:: ../_static/wrover-jp1-both.png -.. |jp7-ext_5v| image:: ../_static/wrover-jp7-ext_5v.png -.. |jp7-usb_5v| image:: ../_static/wrover-jp7-usb_5v.png -.. |jp8| image:: ../_static/wrover-jp8.png -.. |jp11-rx-tx| image:: ../_static/wrover-jp11-tx-rx.png -.. |jp14| image:: ../_static/wrover-jp14.png +.. |jp1-sd_io2| image:: ../../_static/wrover-jp1-sd_io2.png +.. |jp1-both| image:: ../../_static/wrover-jp1-both.png +.. |jp7-ext_5v| image:: ../../_static/wrover-jp7-ext_5v.png +.. |jp7-usb_5v| image:: ../../_static/wrover-jp7-usb_5v.png +.. |jp8| image:: ../../_static/wrover-jp8.png +.. |jp11-rx-tx| image:: ../../_static/wrover-jp11-tx-rx.png +.. |jp14| image:: ../../_static/wrover-jp14.png .. _ESP-WROVER-KIT V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf 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 95% rename from docs/get-started/index.rst rename to docs/en/get-started/index.rst index 068bd872f..4c509cdf2 100644 --- a/docs/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -24,7 +24,7 @@ To develop applications for ESP32 you need: * A text editor to write programs (**Projects**) in C, e.g. `Eclipse `_ * The **ESP32** board itself and a **USB cable** to connect it to the **PC** -.. figure:: ../_static/what-you-need.png +.. figure:: ../../_static/what-you-need.png :align: center :alt: Development of applications for ESP32 :figclass: align-center @@ -84,13 +84,13 @@ The quickest way to start development with ESP32 is by installing a prebuilt too | `Windows`_ | `Linux`_ | `Mac OS`_ | +-------------------+-------------------+-------------------+ -.. |windows-logo| image:: ../_static/windows-logo.png +.. |windows-logo| image:: ../../_static/windows-logo.png :target: ../get-started/windows-setup.html -.. |linux-logo| image:: ../_static/linux-logo.png +.. |linux-logo| image:: ../../_static/linux-logo.png :target: ../get-started/linux-setup.html -.. |macos-logo| image:: ../_static/macos-logo.png +.. |macos-logo| image:: ../../_static/macos-logo.png :target: ../get-started/macos-setup.html .. _Windows: ../get-started/windows-setup.html @@ -175,7 +175,7 @@ Being in terminal window, go to directory of ``hello_world`` application by typi If previous steps have been done correctly, the following menu will be displayed: -.. figure:: ../_static/project-configuration.png +.. figure:: ../../_static/project-configuration.png :align: center :alt: Project configuration - Home window :figclass: align-center 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 97% rename from docs/get-started/windows-setup.rst rename to docs/en/get-started/windows-setup.rst index b2404996e..2085e9108 100644 --- a/docs/get-started/windows-setup.rst +++ b/docs/en/get-started/windows-setup.rst @@ -23,7 +23,7 @@ Check it Out Open a MSYS2 MINGW32 terminal window by running ``C:\msys32\mingw32.exe``. The environment in this window is a bash shell. -.. figure:: ../_static/msys2-terminal-window.png +.. figure:: ../../_static/msys2-terminal-window.png :align: center :alt: MSYS2 MINGW32 shell window :figclass: align-center 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/en/index.rst b/docs/en/index.rst new file mode 100644 index 000000000..f3445d8dc --- /dev/null +++ b/docs/en/index.rst @@ -0,0 +1,48 @@ +ESP-IDF Programming Guide +========================= + +This is the documentation for Espressif IoT Development Framework (`esp-idf `_). ESP-IDF is the official development framework for the `ESP32 `_ chip. + +================== ================== ================== +|Get Started|_ |API Reference|_ |H/W Reference|_ +------------------ ------------------ ------------------ +`Get Started`_ `API Reference`_ `H/W Reference`_ +------------------ ------------------ ------------------ +|API Guides|_ |Contribute|_ |Resources|_ +------------------ ------------------ ------------------ +`API Guides`_ `Contribute`_ `Resources`_ +================== ================== ================== + + +.. |Get Started| image:: ../_static/get-started.gif +.. _Get Started: get-started/index.html + +.. |API Reference| image:: ../_static/api-reference.gif +.. _API Reference: api-reference/index.html + +.. |H/W Reference| image:: ../_static/hw-reference.gif +.. _H/W Reference: hw-reference/index.html + +.. |Api Guides| image:: ../_static/api-guides.gif +.. _Api Guides: api-guides/index.html + +.. |Contribute| image:: ../_static/contribute.gif +.. _Contribute: contribute/index.html + +.. |Resources| image:: ../_static/resources.gif +.. _Resources: resources.html + + +.. toctree:: + :hidden: + + Get Started + API Reference + H/W Reference + API Guides + Contribute + Resources + Copyrights + About + +* :ref:`genindex` 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/gen-dxd.py b/docs/gen-dxd.py index 4ebf06b43..0737d94f6 100644 --- a/docs/gen-dxd.py +++ b/docs/gen-dxd.py @@ -16,10 +16,10 @@ if 'BUILDDIR' in os.environ: builddir = os.environ['BUILDDIR'] # Script configuration -header_file_path_prefix = "../components/" +header_file_path_prefix = "../../components/" """string: path prefix for header files. """ -doxyfile_path = "Doxyfile" +doxyfile_path = "../Doxyfile" """string: path to a file containing header files to processs. """ xml_directory_path = "xml" diff --git a/docs/gen-kconfig-doc.py b/docs/gen-kconfig-doc.py index 0c35dc60b..a14164119 100755 --- a/docs/gen-kconfig-doc.py +++ b/docs/gen-kconfig-doc.py @@ -106,7 +106,7 @@ def print_all_components(): heading_level = INITIAL_HEADING_LEVEL # Currently this works only for IDF components. # TODO: figure out if this can be re-used for documenting applications? - components_path = os.path.join(os.path.curdir, '..', 'components') + components_path = os.path.join(os.path.curdir, '../..', 'components') for component_name in os.listdir(components_path): if component_name.startswith('.'): continue # skip system thumbnail folders diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index a7ff1ee91..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,49 +0,0 @@ -ESP-IDF Programming Guide -========================= - -This is the documentation for Espressif IoT Development Framework (`esp-idf `_). ESP-IDF is the official development framework for the `ESP32 `_ chip. - -+------------------+------------------+------------------+ -| |Get Started|_ | |API Reference|_ | |H/W Reference|_ | -+------------------+------------------+------------------+ -| `Get Started`_ | `API Reference`_ | `H/W Reference`_ | -+------------------+------------------+------------------+ -| |API Guides|_ | |Contribute|_ | |Resources|_ | -+------------------+------------------+------------------+ -| `API Guides`_ | `Contribute`_ | `Resources`_ | -+------------------+------------------+------------------+ - - -.. |Get Started| image:: _static/get-started.gif -.. _Get Started: get-started/index.html - -.. |API Reference| image:: _static/api-reference.gif -.. _API Reference: api-reference/index.html - -.. |H/W Reference| image:: _static/hw-reference.gif -.. _H/W Reference: hw-reference/index.html - -.. |Api Guides| image:: _static/api-guides.gif -.. _Api Guides: api-guides/index.html - -.. |Contribute| image:: _static/contribute.gif -.. _Contribute: contribute/index.html - -.. |Resources| image:: _static/resources.gif -.. _Resources: resources.html - - -.. toctree:: - :hidden: - - Get Started - 快速入门 - API Reference - H/W Reference - API Guides - Contribute - Resources - Copyrights - About - -* :ref:`genindex` diff --git a/docs/zh_CN/COPYRIGHT.rst b/docs/zh_CN/COPYRIGHT.rst new file mode 100644 index 000000000..5caf70ca8 --- /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 000000000..cc32abbd5 --- /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 000000000..63cda2696 --- /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 000000000..b19b47572 --- /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 000000000..59a435e3a --- /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 000000000..12ac41ed8 --- /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 000000000..dd6f985af --- /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 000000000..5acbd8324 --- /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 000000000..826dbef81 --- /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 000000000..11fe46540 --- /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 000000000..16a4ba2d2 --- /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 000000000..fd8bf4705 --- /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 000000000..6a77766fc --- /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 000000000..a6a7d8566 --- /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 000000000..36c4701ad --- /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 000000000..70481a7bf --- /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 000000000..34cef1021 --- /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 000000000..720df4b50 --- /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 000000000..d79518837 --- /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 000000000..ee8c9594c --- /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 000000000..8a42b5678 --- /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 000000000..16059fc9c --- /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 000000000..fd8f49ba6 --- /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 000000000..cb3368c6a --- /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 000000000..aaf7dfadf --- /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 000000000..e34bc0973 --- /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 000000000..10eca6408 --- /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 000000000..59791099e --- /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/thread-local-storage.rst b/docs/zh_CN/api-guides/thread-local-storage.rst new file mode 100644 index 000000000..8121f7c9f --- /dev/null +++ b/docs/zh_CN/api-guides/thread-local-storage.rst @@ -0,0 +1 @@ +.. include:: ../../en/api-guides/thread-local-storage.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 000000000..976d6db28 --- /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 000000000..e36036d26 --- /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 000000000..408f1d695 --- /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 000000000..d42993f78 --- /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 000000000..50c7164e6 --- /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 000000000..e6f9ae072 --- /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 000000000..24b978c97 --- /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 000000000..7ce047bbb --- /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 000000000..da752e56b --- /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 000000000..1c9306565 --- /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 000000000..daf21d215 --- /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 000000000..ab40ae631 --- /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 000000000..9e6b668f8 --- /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 000000000..9bd127aa5 --- /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 000000000..e1b655a67 --- /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 000000000..476a00a40 --- /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 000000000..1984edefa --- /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 000000000..5329282e5 --- /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 000000000..c53df82ad --- /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 000000000..87f8b278e --- /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 000000000..8dd9ca243 --- /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 000000000..0379710c3 --- /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 000000000..00cb4e891 --- /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 000000000..949fe213e --- /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 000000000..9c7237673 --- /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 000000000..db107787e --- /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 000000000..992087787 --- /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 000000000..f0f7f7166 --- /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 000000000..52fdd1655 --- /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 000000000..f32a051b6 --- /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 000000000..493e5b949 --- /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 000000000..3ac36bb8e --- /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 000000000..d2374420f --- /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 000000000..a918a58c9 --- /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 000000000..c4d1cf83d --- /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 000000000..4b79094eb --- /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 000000000..8a26b7a8d --- /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 000000000..6ff2b181c --- /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 000000000..21dcf9b0a --- /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 000000000..777ec06c2 --- /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 000000000..15df578a7 --- /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 000000000..3a95c0b7a --- /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 000000000..9cf7b7072 --- /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 000000000..3f82c5d80 --- /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 000000000..a867563eb --- /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 000000000..f30a807b7 --- /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 000000000..88fef50af --- /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 000000000..b2db3d718 --- /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 000000000..1856da13f --- /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 000000000..4179e3c66 --- /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 000000000..fa1aef627 --- /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 000000000..065b71454 --- /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 000000000..64afb5e2f --- /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 000000000..05cfa83ba --- /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 000000000..2f7842525 --- /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 000000000..67f97f505 --- /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 000000000..d8bc64794 --- /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 000000000..487fb9910 --- /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 000000000..cdf03b734 --- /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 000000000..7e5576cd4 --- /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 000000000..16ce297d1 --- /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 000000000..937069744 --- /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 000000000..3b8455344 --- /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 000000000..41ed0bcb7 --- /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 000000000..e55e0543a --- /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 000000000..3add4e8ef --- /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 000000000..65f9c73d2 --- /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 000000000..a15cc6e4f --- /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 000000000..6023755f6 --- /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 000000000..251cc590a --- /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 000000000..7d88405f5 --- /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 000000000..5cf31c597 --- /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 000000000..9247af12a --- /dev/null +++ b/docs/zh_CN/conf.py @@ -0,0 +1,335 @@ +# -*- 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 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 local_util import run_cmd_get_output, copy_if_modified + +builddir = '_build' +if 'BUILDDIR' in os.environ: + builddir = os.environ['BUILDDIR'] + +# Call Doxygen to get XML files from the header files +print "Calling Doxygen to generate latest XML files" +os.system("doxygen ../Doxyfile") +# Doxygen has generated XML files in 'xml' directory. +# Copy them to 'xml_in', only touching the files which have changed. +copy_if_modified('xml/', 'xml_in/') + +# 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 +kconfig_inc_path = '{}/inc/kconfig.inc'.format(builddir) +os.system('python ../gen-kconfig-doc.py > ' + kconfig_inc_path + '.in') +copy_if_modified(kconfig_inc_path + '.in', kconfig_inc_path) + +# 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 + +# Doxygen regenerates files in 'xml/' directory every time, +# but we copy files to 'xml_in/' only when they change, to speed up +# incremental builds. +breathe_projects = { "esp32-idf": "xml_in/" } +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 = 'zh_CN' + +# 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 000000000..667b9a6a6 --- /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 000000000..14493ca87 --- /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 000000000..36e983992 --- /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 000000000..275b9894c --- /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 000000000..7ece4ab8f --- /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 000000000..ba15bc9db --- /dev/null +++ b/docs/zh_CN/get-started/eclipse-setup-windows.rst @@ -0,0 +1,81 @@ +***************************************************** +Eclipse IDE 的创建和烧录指南（Windows 平台） +***************************************************** + +Windows 平台上的 Eclipse 配置略有不同，具体步骤请见下文。 + +注意：OS X 和 Linux 平台上的 Eclipse IDE 配置，请见 :doc:`Eclipse IDE page `。 + +安装 Eclipse IDE +================== + +Windows 平台的 Eclipse 安装步骤与其他平台相同，请见 :ref:`Installing Eclipse IDE `。 + +.. _eclipse-windows-setup: + + +Windows 平台上的 Eclipse 配置 +================================ + +完成 Eclipse IDE 的安装后，请按照下列步骤继续操作： + +导入新项目 +------------- + +* Eclipse IDE 需使用 ESP-IDF 的 Makefile 功能。因此，在使用 Eclipse 前，您需要先创建一个 ESP-IDF 项目。在创建 ESP-IDF 项目时，您可以使用 GitHub 中的 idf-template 项目模版，或从 esp-idf 子目录中选择一个 example。 + +* 运行 Eclipse，选择 “File” -> “Import...”。 + +* 在弹出的对话框中选择 “C/C++” -> “Existing Code as Makefile Project”，然后点击 “Next”。 + +* 下个界面，在 “Existing Code Location” 位置输入您的 IDF 项目的路径。注意，这里应填入 ESP-IDF 项目的路径，而非 ESP-IDF 的路径（稍后再填写）。此外，您指定的目录中应包含名为 “Makefile”（项目 Makefile）的文件。 + +* 在同一页面上，在 “Toolchain for Indexer Settings” 下取消选中 “Show only available toolchains that support this platform”。 + +* 在出现的扩展列表中，选择 “Cygwin GCC”。然后点击 “Finish”。 + +*注意：您可能看到有关“无法找到 Cygwin GCC 工具链”的警告。这种情况并不影响安装，我们只需重新配置 Eclipse，并找到我们的工具链即可。* + +项目属性 +---------- + +* 新项目将出现在 “Project Explorer” 下。请右键选择该项目，并在菜单中选择顶层 “Properties”。 + +* 点击 “C/C++ Build” 属性页。 + + * 取消选中 “Use default build command”，然后输入命令：``python${IDF_PATH}/tools/windows/eclipse_make.py``，开始自定义创建。 + +* 点击 “C/C++ Build” 下的 “Environment” 属性页面。 + + * 选择 “Add...”，并在对应位置输入 ``BATCH_BUILD`` 和 ``1``。 + + * 再次点击 “Add...”，输入名称 ``IDF_PATH``，并填写 ESP-IDF 的完整安装路径。``IDF_PATH`` 目录路径应使用正斜杠，而非反斜线，即 ``C:/Users/MyUser/Development/esp-idf``。 + + * 选择 PATH 环境变量，删除默认值，并将其替换为 ``C:\msys32\usr\bin;C:\msys32\mingw32\bin;C:\msys32\opt\xtensa-esp32-elf\bin`` （如果您已经将 msys32 安装到其他目​​录，这里请自行调整）。 + + +* 点击 “C/C++ General” -> “Preprocessor Include Paths, Macros, etc.” 属性页。 + + * 点击 “Providers” 选项卡。 + + * 从 “Providers” 列表中选择 “CDT GCC Built-in Compiler Settings Cygwin”。在 “Command to get compiler specs” 输入框中，用 ``xtensa-esp32-elf-gcc`` 替换行首的 ``${COMMAND}``，最终完整的 ``Command to get compiler specs`` 应为 ``xtensa-esp32-elf-gcc ${FLAGS} -E -P -v -dD "${INPUTS}"``。 + + * 从 “Providers” 列表中选择 “CDT GCC Build Output Parser”，然后在 Compiler 命令模式的起始位置输入 ``xtensa-esp32-elf-``，并用括号把剩余部分扩起来。最终的完整 Compiler 命令模式应为 ``xtensa-esp32-elf-((g?cc)|([gc]\+\+)|(clang))``。 + + +在 Eclipse IDE 中创建项目 +--------------------------- + +Windows 平台的 Eclipse 项目创建步骤与其他平台相同，请见 :ref:`Building in Eclipse `。 + +技术细节 +========= + +**以下内容仅供 Windows 平台专家或非常感兴趣的开发者阅读。** + +Windows 平台的 Eclipse 介绍到此结束，下方将主要将介绍一些关键步骤的原理，助您了解更多 Eclipse 的背景信息。 + +* 首先，xtensa-esp32-elf-gcc 交叉编译器 *并非* Cygwin 工具链，但我们会在 Eclipse 中指定其为 Cygwin 工具链。主要原因在于：msys2 需要使用 Cygwin，并支持 Unix 风格的路径，即 ``/c/blah``，而非 ``c:/blah`` 或 ``c:\\blah``。特别需要说明的是，``xtensa-esp32-elf-gcc`` 会“告知” Eclipse 的 ``built-in compiler settings`` 功能，其内置 “include” 目录全部位于 ``/usr/`` 路径下，这也是 Eclipse 唯一可以解析的 ``Unix/Cygwin`` 风格路径。通过在 Eclipse 中指定 ``xtensa-esp32-elf-gcc`` 交叉编译器为 Cygwin 编译器，可以让 Eclipse 使用 cygpath 实用程序直接内部解析路径。 + + +* 在解析 ESP-IDF 的 make 结果时也经常会出现同样的问题。Eclipse 可以解析 make 的结果，查找头文件目录，但是无法脱离 ``cygpath``，直接解析类似 ``/c/blah`` 的目录。``Eclipse Build Output Parser`` 将利用该机制确认是否调用 ``cygpath``，但由于未知原因，目前 ESP-IDF 配置并不会触发该功能。出于这个原因，我们会使用 ``eclipse_make.py`` 包装脚本调用 ``make``，然后使用 ``cygpath`` 处理 Eclipse 的结果。 \ 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 000000000..8db863942 --- /dev/null +++ b/docs/zh_CN/get-started/eclipse-setup.rst @@ -0,0 +1,108 @@ +**************************** +Eclipse IDE 的创建和烧录指南 +**************************** + +.. _eclipse-install-steps: + +安装 Eclipse IDE +================ + +Eclipse IDE 是一个可视化的集成开发环境，可用于编写、编译和调试 ESP-IDF 项目。 + +* 首先，请在您的平台上安装相应的 ESP-IDF，具体步骤请参考适用于 Windows、OS X 和 Linux 的相应安装步骤。 + +* 我们建议，您应首先使用命令行创建一个项目，大致熟悉项目的创建流程。此外，您还需要使用命令行 (``make menuconfig``) 对您的 ESP-IDF 项目进行配置。目前，Eclipse 尚不支持对 ESP-IDF 项目进行配置。 + +* 下载相应版本的 Eclipse Installer 至您的平台，点击 eclipse.org_。 + +* 运行 Eclipse Installer，选择 “Eclipse for C/C++ Development”（有的版本也可能显示为 CDT）。 + +Windows 用户 +============ + +在 Windows 平台上使用 Eclipse IDE 的用户，请参考 :ref:`Windows 用户的 Eclipse IDE 使用指南 `。 + +配置 Eclipse IDE +================= + +请打开安装好的 Eclipse IDE，并按照以下步骤进行操作： + +导入新项目 +---------- + +* Eclipse IDE 需使用 ESP-IDF 的 Makefile 功能。因此，在使用 Eclipse 前，您需要先创建一个 ESP-IDF 项目。在创建 ESP-IDF 项目时，您可以使用 GitHub 中的 idf-template 项目模版，或从 esp-idf 子目录中选择一个 example。 + +* 运行 Eclipse，选择 “File” -> “Import...”。 + +* 在弹出的对话框中选择 “C/C++” -> “Existing Code as Makefile Project”，然后点击 “Next”。 + +* 在下个界面中 “Existing Code Location” 位置输入您的 IDF 项目的路径。注意，这里应输入 ESP-IDF 项目的路径，而非 ESP-IDF 本身的路径（这个稍后再填）。此外，您指定的目标路径中应包含名为 ``Makefile`` （项目 Makefile）的文件。 + +* 在本界面，找到 “Toolchain for Indexer Settings”，选择 “Cross GCC”，最后点击 “Finish”。 + + +项目属性 +-------- + +* 新项目将出现在 “Project Explorer” 下。请右键选择该项目，并在菜单中选择 “Properties”。 + +* 点击 “C/C++ Build” 下的 “Environment” 属性页，选择 “Add...”，并在对应位置输入 ``BATCH_BUILD`` 和 ``1``。 + +* 再次点击 “Add...”，并在 “IDF_PATH” 中输入 ESP-IDF 所在的完整安装路径。 + +* 选择 “PATH” 环境变量，不要改变默认值。如果 Xtensa 工具链的路径尚不在 “PATH” 列表中，则应将该路径 (``something/xtensa-esp32-elf/bin``) 增加至列表。 + +* 在 macOS 平台上，增加一个 “PYTHONPATH” 环境变量，并将其设置为 ``/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages``， 保证系统中预先安装的 Python （需安装 pyserial 模块）可以覆盖 Eclipse 内置的任何 Python。 + +* 前往 “C/C++ General” -> “Preprocessor Include Paths” 属性页面。 + + * 点击 “Providers” 选项卡。从 “Providers” 列表中选择 “CDT Cross GCC Built-in Compiler Settings”。在 “Command to get compiler specs” 输入框中，用 ``xtensa-esp32-elf-gcc`` 替换行首的 ``${COMMAND}``，最终的完整 “Command to get compiler specs” 应为 ``xtensa-esp32-elf-gcc ${FLAGS} -E -P -v -dD "${INPUTS}"``。 + + * 从 “Providers” 列表中选择 “CDT GCC Build Output Parser”，然后在 “Compiler command pattern“ 输入框的起始位置输入 ``xtensa-esp32-elf-``，最终的完整编译器命令应为 ``xtensa-esp32-elf-(g?cc)|([gc]\+\+)|(clang)``。 + +.. _eclipse-build-project: + +在 Eclipse IDE 中创建项目 +-------------------------- + +在首次创建项目前，Eclipse IDE 可能会显示大量有关未定义值的错误和警告，主要原因在于项目编译过程中所需的一些源文件是在 ESP-IDF 项目创建过程中自动生成的。因此，这些错误和警告将在 ESP-IDF 项目生成完成后消失。 + +* 点击 “OK”，关闭 Eclipse IDE 中的 “Properties” 对话框。 + +* 在 Eclipse IDE 界面外，打开命令管理器。进入项目目录，并通过 ``make menuconfig`` 命令对您的 ESP-IDF 项目进行配置。现阶段，您还无法在 Eclipse 中完成本操作。 + +*如果您未进行最开始的配置步骤，ESP-IDF 将提示在命令行中进行配置 - 但由于 Eclipse 暂时不支持相关功能，因此该项目将挂起或创建失败。* + +* 返回 Eclipse IDE 界面中，选择 “Project” -> “Build” 创建您的项目。 + +**提示**：如果您已经在 Eclipse IDE 环境外创建了项目，则可能需要选择 “Project” -> “Clean before choosing Project” -> “Build”，允许 Eclipse 查看所有源文件的编译器参数，并借此确定头文件包含路径。 + +在 Eclipse IDE 中烧录项目 +-------------------------- + +您可以将 ``make flash`` 目标放在 Eclipse 项目中，通过 Eclipse UI 调用 ``esptool.py`` 进行烧录： + +* 打开 “Project Explorer”，并右击您的项目（请注意右击项目本身，而非项目下的子文件，否则 Eclipse 可能会找到错误的 ``Makefile``）。 + +* 从菜单中选择 “Make Targets” -> “Create”。 + +* 输入 “flash” 为目标名称，其他选项使用默认值。 + +* 选择 “Project” -> “Make Target” -> “Build (快捷键：Shift + F9）”，创建自定义烧录目标，用于编译、烧录项目。 + +注意，您将需要通过 ``make menuconfig``，设置串行端口和其他烧录选项。``make menuconfig`` 仍需通过命令行操作（请见平台的对应指南）。 + +如有需要，请按照相同步骤添加 ``bootloader`` 和 ``partition_table``。 + +相关文档 +-------- + +.. toctree:: + :maxdepth: 1 + + eclipse-setup-windows + + +.. _eclipse.org: https://www.eclipse.org/ + + 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 000000000..4cae221a5 --- /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 000000000..ecb30677d --- /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 000000000..522695d65 --- /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 000000000..78f066451 --- /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 000000000..d2e44c905 --- /dev/null +++ b/docs/zh_CN/get-started/get-started-pico-kit.rst @@ -0,0 +1,219 @@ +ESP32-PICO-KIT V4 入门指南 +============================ + +本指南介绍了如何开始使用 ESP32-PICO-KIT V4 迷你开发板。有关 ESP32-PICO-KIT 其他版本的介绍，请见 :doc:`../hw-reference/index`。 + + +准备工作 +-------- + +* 1 × :ref:`ESP32-PICO-KIT V4 迷你开发板 ` +* 1 × USB A/Micro USB B 电缆 +* 1 × PC（Windows、Linux 或 Mac OS 操作系统） + +如果您希望直接开始使用 ESP32-PICO-KIT，请见章节 `应用程序开发`_. + + +简介 +---- + +ESP32-PICO-KIT V4 是一款来自 `乐鑫 `_ 的开发板，其核心采用了具有完整 Wi-Fi 和蓝牙功能的 ESP32 系列 SIP 模组 ESP32-PICO-D4。与其他 ESP32 系列模组相比，ESP32-PICO-D4 模组已将 40 MHz 晶体振荡器、4 MB flash、滤波电容及射频匹配链路等所有外围器件无缝集成进封装内，无需外围元器件即可工作。这将大大降低了用户额外采购元器件的数量和成本，及额外组装测试的复杂度。 + +ESP32-PICO-KIT V4 集成了一个 USB-UART 桥接电路，可连接至 PC 的 USB 端口进行下载和调试。 + +为了便于连接，ESP32-PICO-D4 上的所有 IO 信号和系统电源管脚均通过开发板两侧的排针（每侧 20 个 x 0.1 英寸间隔）引出。为了方便在微型面包板上的使用，ESP32-PICO-KIT V4 开发板每侧的 20 个管脚中，有 17 个引出了排针，另外 3 个靠近天线的管脚不引出，可供用户最后焊接使用。 + +.. note:: + + 每排未引出排针的 3 个管脚已连接至 ESP32-PICO-D4 SIP 模组的内置 flash 模块。更多信息，请见 `相关文档`_ 中的模组技术规格书。 + +ESP32-PICO-KIT V4 开发板的尺寸为 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4")，具体请见 `开发板尺寸`_ 章节。本迷你开发板的功能框图如下图所示。 + +.. figure:: ../../_static/esp32-pico-kit-v4-functional-block-diagram.png + :align: center + :alt: ESP32-PICO-KIT V4 functional block diagram + :figclass: align-center + + ESP32-PICO-KIT V4 功能框图 + + +功能说明 +-------- + +ESP32-PICO-KIT V4 开发板的主要元件、接口及控制方式如下文所示。 + +ESP32-PICO-D4 + ESP32-PICO-KIT V4 开发板上焊接的标准 ESP32-PICO-D4 模组，集成了 ESP32 芯片的完整系统，仅需连接天线、LC 匹配电路、退耦电容和 EN 信号上拉电阻即可正常工作。 + +LDO + 5V-to-3.3V 低压差稳压器 + +USB-UART 桥接器 + 单芯片 USB-UART 桥接器，可提供高达 1 Mbps 的传输速率。 + +Micro USB 接口 + USB 接口，可用作电路板的供电电源及连接 PC 端的通信接口。 + +5V LED 电源指示灯 + 当开发板通电后（USB 或外部 5V），该指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。 + +I/O + I/O ESP32-PICO-D4 上的所有管脚均通过开发板的排针引出。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。更多信息，请见章节 `管脚说明`_。 + +BOOT 键 + 按下 BOOT 键并保持，同时按一下 EN 键（此时不要松开 BOOT 键）进入固件下载模式，通过串口下载固件。 + +EN 键 + 复位键，可重置系统。 + +.. _get-started-pico-kit-v4-board-front: + +.. figure:: ../../_static/esp32-pico-kit-v4-layout.jpg + :align: center + :alt: ESP32-PICO-KIT V4 board layout + :figclass: align-center + + ESP32-PICO-KIT V4 开发板布局 + + +电源选项 +-------- + +ESP32-PICO-KIT V4 支持以下几种供电模式： + +1. Micro USB 接口供电（默认） +2. 5V/GND 管脚供电 +3. 3V3/GND 管脚供电 + +.. warning:: + + 上述供电模式不可同时连接，否则可能会损坏电路板和/或电源。 + + +应用程序开发 +------------ + +在 ESP32-PICO-KIT V4 上电前，请首先确认电路板完好无损。 + + +有关应用程序开发的具体步骤，请见章节 :doc:`index`： + +* :ref:`设置 Toolchain `，以便用 C 语言开发应用 +* :ref:`连接 ` 模组至 PC，并确认访问状态 +* :ref:`构建并向 ESP32 烧录 example ` +* :ref:`即刻监测 ` 应用程序的动作 + + +管脚说明 +-------- + +下表介绍了开发板 I/O 管脚的 **名称** 和 **功能**，具体布局请见 `相关文档`_ 中的原理图。请参考 :ref:`get-started-pico-kit-v4-board-front` 。 + + +Header J2 +""""""""" + +====== ================= ====== ====================================================== +编号 名称 类型 功能 +====== ================= ====== ====================================================== +1 FLASH_SD1 (FSD1) I/O | GPIO8, SD_DATA1, SPID, HS1_DATA1 :ref:`(1) ` , U2CTS +2 FLASH_SD3 (FSD3) I/O | GPIO7, SD_DATA0, SPIQ, HS1_DATA0 :ref:`(1) ` , U2RTS +3 FLASH_CLK (FCLK) I/O | GPIO11, SD_CMD, SPICS0, HS1_CMD :ref:`(1) ` , U1RTS +4 IO21 I/O | GPIO21, VSPIHD, EMAC_TX_EN +5 IO22 I/O | GPIO22, VSPIWP, U0RTS, EMAC_TXD1 +6 IO19 I/O | GPIO19, VSPIQ, U0CTS, EMAC_TXD0 +7 IO23 I/O | GPIO23, VSPID, HS1_STROBE +8 IO18 I/O | GPIO18, VSPICLK, HS1_DATA7 +9 IO5 I/O | GPIO5, VSPICS0, HS1_DATA6, EMAC_RX_CLK +10 IO10 I/O | GPIO10, SD_DATA3, SPIWP, HS1_DATA3, U1TXD +11 IO9 I/O | GPIO9, SD_DATA2, SPIHD, HS1_DATA2, U1RXD +12 RXD0 I/O | GPIO3, U0RXD :ref:`(4) ` , CLK_OUT2 +13 TXD0 I/O | GPIO1, U0TXD :ref:`(4) ` , CLK_OUT3, EMAC_RXD2 +14 IO35 I | ADC1_CH7, RTC_GPIO5 +15 IO34 I | ADC1_CH6, RTC_GPIO4 +16 IO38 I | GPIO38, ADC1_CH2, ADC_PRE_AMP :ref:`(2b) ` , RTC_GPIO2 +17 IO37 I | GPIO37, ADC_PRE_AMP :ref:`(2a) ` , ADC1_CH1, RTC_GPIO1 +18 EN I | CHIP_PU +19 GND P | Ground +20 VDD33 (3V3) P | 3.3V 电源 +====== ================= ====== ====================================================== + + +Header J3 +""""""""" + +====== ================= ====== ====================================================== +编号 名称 类型 功能 +====== ================= ====== ====================================================== +1 FLASH_CS (FCS) I/O | GPIO16, HS1_DATA4 :ref:`(1) ` , U2RXD, EMAC_CLK_OUT +2 FLASH_SD0 (FSD0) I/O | GPIO17, HS1_DATA5 :ref:`(1) ` , U2TXD, EMAC_CLK_OUT_180 +3 FLASH_SD2 (FSD2) I/O | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`(1) ` , U1CTS +4 SENSOR_VP (FSVP) I | GPIO36, ADC1_CH0, ADC_PRE_AMP :ref:`(2a) ` , RTC_GPIO0 +5 SENSOR_VN (FSVN) I | GPIO39, ADC1_CH3, ADC_PRE_AMP :ref:`(2b) ` , RTC_GPIO3 +6 IO25 I/O | GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0 +7 IO26 I/O | GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1 +8 IO32 I/O | 32K_XP :ref:`(3a) ` , ADC1_CH4, TOUCH9, RTC_GPIO9 +9 IO33 I/O | 32K_XN :ref:`(3b) ` , ADC1_CH5, TOUCH8, RTC_GPIO8 +10 IO27 I/O | GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17 + | EMAC_RX_DV +11 IO14 I/O | ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK, + | HS2_CLK, SD_CLK, EMAC_TXD2 +12 IO12 I/O | ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI :ref:`(5) ` , HSPIQ, + | HS2_DATA2, SD_DATA2, EMAC_TXD3 +13 IO13 I/O | ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID, + | HS2_DATA3, SD_DATA3, EMAC_RX_ER +14 IO15 I/O | ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0 + | HS2_CMD, SD_CMD, EMAC_RXD3 +15 IO2 I/O | ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, + | HS2_DATA0, SD_DATA0 +16 IO4 I/O | ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD, + | HS2_DATA1, SD_DATA1, EMAC_TX_ER +17 IO0 I/O | ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1 + | EMAC_TX_CLK +18 VDD33 (3V3) P | 3.3V 电源 +19 GND P | Ground +20 EXT_5V (5V) P | 5V 电源 +====== ================= ====== ====================================================== + + +.. _get-started-pico-kit-v4-pin-notes: + +**备注** + + 1. 该管脚已连接至 ESP32-PICO-D4 的内置 flash 管脚。 + 2. 当用作 ADC_PRE_AMP 时，请在以下位置增加 270 pF 电容：(a) SENSOR_VP 和 IO37 之间；(b) SENSOR_VN 和 IO38 之间。 + 3. 32.768 kHz 晶振：(a) 输入；(b) 输出。 + 4. 该管脚已连接至开发板的 USB 桥接器芯片。 + 5. ESP32-PICO-KIT 内置 SPI flash 的工作电压为 3.3V。因此，strapping 管脚 MTDI 在模组重启过程中应保持低电平。 + + +开发板尺寸 +---------- + +.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-back.jpg + :align: center + :alt: ESP32-PICO-KIT V4 dimensions - back + :figclass: align-center + + ESP32-PICO-KIT V4 尺寸图 - 背面 + +.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-side.jpg + :align: center + :alt: ESP32-PICO-KIT V4 dimensions - side + :figclass: align-center + + ESP32-PICO-KIT V4 尺寸图 - 侧面 + + +相关文档 +----------------- + +* `ESP32-PICO-KIT V4 原理图 `_ (PDF) +* `ESP32-PICO-D4 技术规格书 `_ (PDF) +* :doc:`../hw-reference/index` + + +.. toctree:: + :hidden: + + get-started-pico-kit-v3 \ 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 000000000..88764b0f8 --- /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 000000000..50944db78 --- /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 000000000..a3c3f4f17 --- /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/get-started/index-cn.rst b/docs/zh_CN/get-started/index.rst similarity index 91% rename from docs/get-started/index-cn.rst rename to docs/zh_CN/get-started/index.rst index 5d2a21da3..387e68ceb 100644 --- a/docs/get-started/index-cn.rst +++ b/docs/zh_CN/get-started/index.rst @@ -23,7 +23,7 @@ ESP32 是一套 Wi-Fi (2.4 GHz) 和蓝牙 (4.2) 双模解决方案，集成了 * **文本编辑器**：编写 C 语言程序，例如 `Eclipse `_ * **ESP32 开发板** 和将其连接到 **电脑** 的 **USB 线** -.. figure:: ../_static/what-you-need.png +.. figure:: ../../_static/what-you-need.png :align: center :alt: Development of applications for ESP32 :figclass: align-center @@ -61,7 +61,7 @@ ESP32 是一套 Wi-Fi (2.4 GHz) 和蓝牙 (4.2) 双模解决方案，集成了 如果你使用其它开发板，请查看下面的内容。 -.. _get-started-setup-toolchain-cn: +.. _get-started-setup-toolchain: 设置工具链 =============== @@ -71,8 +71,8 @@ ESP32 是一套 Wi-Fi (2.4 GHz) 和蓝牙 (4.2) 双模解决方案，集成了 .. toctree:: :hidden: - Windows <../get-started/windows-setup-cn> - Linux <../get-started/linux-setup-cn> + Windows <../get-started/windows-setup> + Linux <../get-started/linux-setup> MacOS <../get-started/macos-setup> +-------------------+-------------------+-------------------+ @@ -81,17 +81,17 @@ ESP32 是一套 Wi-Fi (2.4 GHz) 和蓝牙 (4.2) 双模解决方案，集成了 | `Windows`_ | `Linux`_ | `Mac OS`_ | +-------------------+-------------------+-------------------+ -.. |windows-logo| image:: ../_static/windows-logo.png - :target: ../get-started/windows-setup-cn.html +.. |windows-logo| image:: ../../_static/windows-logo.png + :target: ../get-started/windows-setup.html -.. |linux-logo| image:: ../_static/linux-logo.png - :target: ../get-started/linux-setup-cn.html +.. |linux-logo| image:: ../../_static/linux-logo.png + :target: ../get-started/linux-setup.html -.. |macos-logo| image:: ../_static/macos-logo.png +.. |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 +.. _Windows: ../get-started/windows-setup.html +.. _Linux: ../get-started/linux-setup.html .. _Mac OS: ../get-started/macos-setup.html .. note:: @@ -100,9 +100,9 @@ ESP32 是一套 Wi-Fi (2.4 GHz) 和蓝牙 (4.2) 双模解决方案，集成了 你可以安装预编译的工具链或者自定义你的环境，这完全取决于个人经验和偏好。如果你要自定义环境，请参考 :ref:`get-started-customized-setup`。 -工具链设置完成后，就可以 :ref:`get-started-get-esp-idf-cn` 了。 +工具链设置完成后，就可以 :ref:`get-started-get-esp-idf` 了。 -.. _get-started-get-esp-idf-cn: +.. _get-started-get-esp-idf: 获取 ESP-IDF ================= @@ -124,7 +124,7 @@ ESP-IDF 将会被下载到 ``~/esp/esp-idf``。 git submodule update --init -.. _get-started-setup-path-cn: +.. _get-started-setup-path: 设置 ESP-IDF 路径 ===================== @@ -132,7 +132,7 @@ ESP-IDF 将会被下载到 ``~/esp/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: +.. _get-started-start-project: 创建一个工程 =============== @@ -150,14 +150,14 @@ ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照 esp-idf 构建系统不支持在路径中存在空格。 -.. _get-started-connect-cn: +.. _get-started-connect: 连接 ======= 还有几个步骤就完成了。在继续后续操作前，先将 ESP32 开发板连接到 PC，然后检查串口号，看看它能否正常通信。如果你不知道如何操作，请查看 Establish Serial Connection with ESP32 中的相关指导。请注意一下端口号，我们在下一步中会用到。 -.. _get-started-configure-cn: +.. _get-started-configure: 配置 ========= @@ -169,7 +169,7 @@ ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照 如果之前的步骤都正确，则会显示下面的菜单： -.. figure:: ../_static/project-configuration.png +.. figure:: ../../_static/project-configuration.png :align: center :alt: Project configuration - Home window :figclass: align-center @@ -197,7 +197,7 @@ ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照 如果你是 **Arch Linux** 用户，需要进入 ``SDK tool configuration`` 将 ``Python 2 interpreter`` 从 ``python`` 修改为 ``python2``。 -.. _get-started-build-flash-cn: +.. _get-started-build-flash: 编译和烧写 =============== @@ -242,7 +242,7 @@ ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照 如果你想使用 Eclipse IDE 而不是运行 ``make``，请参考 :doc:`Eclipse guide `。 -.. _get-started-build-monitor-cn: +.. _get-started-build-monitor: 监视器 ======= @@ -278,7 +278,7 @@ ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照 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 中配置。 + 或者监视器程序启动失败，那么可能你的开发板用的是 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 ` 里的快捷键和更多内容。 @@ -289,7 +289,7 @@ ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照 更新 ESP-IDF ============= -使用 ESP-IDF 一段时间后，你可能想要进行升级来获得新的性能或者对 bug 进行修复。最简单的更新方式是删除已有的 ``esp-idf`` 文件夹然后再克隆一个，即重复 :ref:`get-started-get-esp-idf-cn` 里的操作。 +使用 ESP-IDF 一段时间后，你可能想要进行升级来获得新的性能或者对 bug 进行修复。最简单的更新方式是删除已有的 ``esp-idf`` 文件夹然后再克隆一个，即重复 :ref:`get-started-get-esp-idf` 里的操作。 另外一种方法是只更新有改动的部分，如果你不容易登陆 GitHub，那么这种方法比较合适。执行以下命令： :: 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 000000000..be9ac0158 --- /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/get-started/linux-setup-cn.rst b/docs/zh_CN/get-started/linux-setup.rst similarity index 98% rename from docs/get-started/linux-setup-cn.rst rename to docs/zh_CN/get-started/linux-setup.rst index 7eefd3a2d..bf0a09546 100644 --- a/docs/get-started/linux-setup-cn.rst +++ b/docs/zh_CN/get-started/linux-setup.rst @@ -38,7 +38,7 @@ Linux 版的 ESP32 工具链可以从 Espressif 的网站下载： 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: +.. _setup-linux-toolchain-add-it-to-path: 2. 工具链将会被解压到 ``~/esp/xtensa-esp32-elf/`` 目录。 @@ -87,7 +87,7 @@ Arch Linux 用户 后续步骤 ========== -要继续设置开发环境，请参考 :ref:`get-started-get-esp-idf-cn` 一节。 +要继续设置开发环境，请参考 :ref:`get-started-get-esp-idf` 一节。 .. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository 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 000000000..f80efb806 --- /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 000000000..a0edfdb16 --- /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 000000000..e2939c219 --- /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 000000000..43a8920c1 --- /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 000000000..6ca82060e --- /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/get-started/windows-setup-cn.rst b/docs/zh_CN/get-started/windows-setup.rst similarity index 96% rename from docs/get-started/windows-setup-cn.rst rename to docs/zh_CN/get-started/windows-setup.rst index 3b67552eb..20e873941 100644 --- a/docs/get-started/windows-setup-cn.rst +++ b/docs/zh_CN/get-started/windows-setup.rst @@ -21,7 +21,7 @@ https://dl.espressif.com/dl/esp32_win32_msys2_environment_and_toolchain-20180110 运行 ``C:\msys32\mingw32.exe`` 打开一个 MSYS2 的终端窗口。该窗口的环境是一个 bash shell。 -.. figure:: ../_static/msys2-terminal-window.png +.. figure:: ../../_static/msys2-terminal-window.png :align: center :alt: MSYS2 MINGW32 shell window :figclass: align-center @@ -33,7 +33,7 @@ https://dl.espressif.com/dl/esp32_win32_msys2_environment_and_toolchain-20180110 后续步骤 ========== -要继续设置开发环境，请参考 :ref:`get-started-get-esp-idf-cn` 一节。 +要继续设置开发环境，请参考 :ref:`get-started-get-esp-idf` 一节。 更新环境 ======================== diff --git a/docs/zh_CN/hw-reference/index.rst b/docs/zh_CN/hw-reference/index.rst new file mode 100644 index 000000000..f550fa4f8 --- /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 000000000..30e33d94c --- /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 000000000..311e160fe --- /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 000000000..9aaab7c30 --- /dev/null +++ b/docs/zh_CN/index.rst @@ -0,0 +1,48 @@ +ESP-IDF Programming Guide +========================= + +This is the documentation for Espressif IoT Development Framework (`esp-idf `_). ESP-IDF is the official development framework for the `ESP32 `_ chip. + +================== ================== ================== +|快速入门|_ |API Reference|_ |H/W Reference|_ +------------------ ------------------ ------------------ +`快速入门`_ `API Reference`_ `H/W Reference`_ +------------------ ------------------ ------------------ +|API Guides|_ |Contribute|_ |Resources|_ +------------------ ------------------ ------------------ +`API Guides`_ `Contribute`_ `Resources`_ +================== ================== ================== + + +.. |快速入门| image:: ../_static/get-started.gif +.. _快速入门: get-started/index.html + +.. |API Reference| image:: ../_static/api-reference.gif +.. _API Reference: api-reference/index.html + +.. |H/W Reference| image:: ../_static/hw-reference.gif +.. _H/W Reference: hw-reference/index.html + +.. |Api Guides| image:: ../_static/api-guides.gif +.. _Api Guides: api-guides/index.html + +.. |Contribute| image:: ../_static/contribute.gif +.. _Contribute: contribute/index.html + +.. |Resources| image:: ../_static/resources.gif +.. _Resources: resources.html + + +.. toctree:: + :hidden: + + 快速入门 + API Reference + H/W Reference + API Guides + Contribute + Resources + Copyrights + About + +* :ref:`genindex` diff --git a/docs/zh_CN/resources.rst b/docs/zh_CN/resources.rst new file mode 100644 index 000000000..320597ae3 --- /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 000000000..3d4a73905 --- /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 000000000..8f46c8e4f --- /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