esp-idf/docs
Zim Kalinowski 0d3f25ecf4 Merge branch 'doc/remove_legacy_event_loop_docs' into 'master'
doc: remove left-over legacy event loop docs

Closes IDF-6189

See merge request espressif/esp-idf!22733
2023-03-21 21:20:22 +08:00
..
_static docs: Fix typo for U0TXD in the diagram 2023-02-21 10:58:35 +08:00
docs_not_updated Merge branch 'feature/esp32h2_secure_boot' into 'master' 2023-03-07 15:27:04 +08:00
doxygen ana_cmpr: add programming guide 2023-03-17 14:35:55 +08:00
en Merge branch 'doc/remove_legacy_event_loop_docs' into 'master' 2023-03-21 21:20:22 +08:00
zh_CN Merge branch 'doc/remove_legacy_event_loop_docs' into 'master' 2023-03-21 21:20:22 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py ana_cmpr: add programming guide 2023-03-17 14:35:55 +08:00
doxygen-known-warnings.txt freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS 2022-12-23 15:29:17 +08:00
page_redirects.txt doc: remove left-over legacy event loop docs 2023-03-17 15:37:26 +08:00
sphinx-known-warnings.txt heap trace standalone: Fix initialization of the unused linked list, update tests 2023-02-14 09:48:14 +01: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