esp-idf/docs
Michael (XIAO Xufeng) 28f9ddee74 Merge branch 'doc/usj_sw_reset_alive_bbpll_doc_v5.0' into 'release/v5.0'
usb_serial_jtag: fixed the docs that we can use usj in sleep modes (v5.0)

See merge request espressif/esp-idf!20287
2022-10-20 01:34:54 +08:00
..
_static docs: update the diagram of FSM of I2S 2022-08-12 17:57:52 +08:00
docs_not_updated ble_mesh: docs: Remove BLE Mesh related reference for C2 2022-09-19 21:11:17 +08:00
doxygen essl: move from esp-idf component to extra component 2022-09-29 07:39:45 +00:00
en Merge branch 'doc/usj_sw_reset_alive_bbpll_doc_v5.0' into 'release/v5.0' 2022-10-20 01:34:54 +08:00
zh_CN docs: provide translation for protocols in migration guides 2022-10-11 18:03:10 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Merge branch 'feature/add_mesh_support_macro_v5.0' into 'release/v5.0' 2022-09-20 16:04:27 +08:00
doxygen-known-warnings.txt
page_redirects.txt
sphinx-known-warnings.txt

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