esp-idf/docs
Mahavir Jain 270af5dca7 Merge branch 'doc/fix_xts_key_length_256_desc' into 'master'
fix(doc): Fix incorrect description for xts_key_length_256 efuse

See merge request espressif/esp-idf!25659
2023-09-01 12:37:30 +08:00
..
_static docs (Bluetooth): add bluetooth overview document 2023-08-15 11:13:14 +08:00
docs_not_updated Merge branch 'feature/p4_wdt' into 'master' 2023-08-31 10:14:19 +08:00
doxygen refactor(freertos): Remove option for Task Snapshot 2023-08-28 20:11:27 +08:00
en Merge branch 'doc/fix_xts_key_length_256_desc' into 'master' 2023-09-01 12:37:30 +08:00
zh_CN Merge branch 'doc/fix_xts_key_length_256_desc' into 'master' 2023-09-01 12:37:30 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Merge branch 'docs/add_bluetooth_overview_page' into 'master' 2023-08-16 19:02:16 +08:00
doxygen-known-warnings.txt docs(mqtt): ignore undocumented APIs 2023-08-31 08:18:39 +08:00
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