Historia

Jakob Hasse 1deef8bee9 docs(heap): Fixed mistake in the heap allocator docs Closes https://github.com/espressif/esp-idf/issues/13353		2024-03-12 10:24:35 +08:00
..
_static	…
docs_not_updated	docs(uart): update lp uart and p4/c5 uart programming guide	2024-03-01 16:21:22 +08:00
doxygen	docs(temperature_sensor): Add new documents for temperature sensor ETM on ESP32C6/H2	2024-03-04 11:36:18 +08:00
en	docs(heap): Fixed mistake in the heap allocator docs	2024-03-12 10:24:35 +08:00
zh_CN	docs(heap): Fixed mistake in the heap allocator docs	2024-03-12 10:24:35 +08:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
check_lang_folder_sync.sh	…
component_info_ignore_file.txt	…
conf_common.py	change(doxyfile): move soc files to target specific doxygen	2024-03-01 10:16:45 +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