esp-idf/docs
Mahavir Jain dec3db6913 Merge branch 'bugfix/freertos_stack_tcb_alloc_order' into 'master'
freertos: fix allocation order for stack and TCB per portSTACK_GROWTH

See merge request espressif/esp-idf!18042
2022-05-11 18:09:49 +08:00
..
_static doc: update api reference for new rmt driver 2022-05-07 10:34:50 +00:00
docs_not_updated dedic_gpio: mention the overhead of using driver API 2022-05-06 18:18:39 +08:00
doxygen doc: update api reference for new rmt driver 2022-05-07 10:34:50 +00:00
en Merge branch 'bugfix/freertos_stack_tcb_alloc_order' into 'master' 2022-05-11 18:09:49 +08:00
zh_CN Merge branch 'docs/update_wifi_multiple_antennas_doc' into 'master' 2022-05-10 15:58:28 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Merge branch 'docs/update_esp_hid_device' into 'master' 2022-05-05 23:58:07 +08:00
doxygen-known-warnings.txt
page_redirects.txt
requirements.txt
sphinx-known-warnings.txt doc: update api reference for new rmt driver 2022-05-07 10:34:50 +00:00

README.md

Documentation Source Folder

This folder contains source files of ESP-IDF documentation available in English and 中文.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated within about 20 minutes on each commit:

Hosted Documentation

The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.

Building Documentation

The documentation is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md