esp-idf/docs
2023-04-27 12:10:54 +08:00
..
_static docs: Describe the approach of fatfsgen.py and fatfsparse.py 2023-04-11 09:41:06 +05:30
docs_not_updated idocs: updated Storage API reference documents for ESP32H2 2023-04-12 08:18:05 +02:00
doxygen esp_clk_tree: Rename clk_tree_xxx to esp_clk_tree_xxx, add compilation warning to clk_tree.h 2023-04-25 14:12:06 +08:00
en docs: provide Chinese translation for api-reference/peripherals/spi_master 2023-04-27 12:10:54 +08:00
zh_CN docs: provide Chinese translation for api-reference/peripherals/spi_master 2023-04-27 12:10: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 ulp: added sleep support for lp core 2023-04-25 11:51:35 +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 heap trace standalone: Fix initialization of the unused linked list, update tests 2023-02-14 09:48:14 +01: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