esp-idf/docs
David Čermák 616b881b91 Merge branch 'bugfix/lwip_dns_docs_v5.0' into 'release/v5.0'
fix(lwip): Document DNS limitation in lwIP (v5.0)

See merge request espressif/esp-idf!27563
2023-12-22 04:43:37 +08:00
..
_static Merge branch 'contrib/github_pr_9694_v5.0' into 'release/v5.0' 2023-09-21 10:37:38 +08:00
docs_not_updated WDT: implement interrupt wdt and task wdt for ESP32-C2 2022-12-01 10:45:35 +00:00
doxygen change(wifi): Add supplicant's public API header files to doc 2023-09-25 10:57:11 +05:30
en Merge branch 'bugfix/lwip_dns_docs_v5.0' into 'release/v5.0' 2023-12-22 04:43:37 +08:00
zh_CN Merge branch 'docs/Separate_low-power_documents_v5.0' into 'release/v5.0' 2023-12-21 11:11:51 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py component/docs: enable generation of API-reference documents for Bluetooth HID host 2023-06-25 15:37:54 +08:00
doxygen-known-warnings.txt
page_redirects.txt freertos: Rename SMP changes document to ESP-IDF FreeRTOS 2023-02-17 20:43:30 +08:00
sphinx-known-warnings.txt docs(fatfs): Move mentioned APIs to a separate API reference section 2023-08-14 12:59:08 +02: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