esp-idf/docs
2024-03-13 09:46:54 +08:00
..
_static feat(docs): added USB Host Stack Configuration description 2024-03-01 09:04:20 +01:00
docs_not_updated Merge branch 'backport/add_docs_for_coex_v51' into 'release/v5.1' 2023-11-23 13:57:42 +08:00
doxygen change(wifi): update esp_coexist_internal.h and esp_modem_wrapper.h 2023-12-19 19:15:49 +08:00
en docs(heap): Fixed mistake in the heap allocator docs 2024-03-13 09:46:54 +08:00
zh_CN docs(heap): Fixed mistake in the heap allocator docs 2024-03-13 09:46:54 +08:00
check_lang_folder_sync.sh global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 2020-04-03 01:10:02 +02:00
conf_common.py docs(build): add cannonical stable url to all docs 2024-02-02 10:36:33 +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
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt docs(fatfs): Move mentioned APIs to a separate API reference section 2023-08-14 12:44:53 +02:00
TEMPLATE_EXAMPLE_README.md docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +08:00

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