mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

mik13ST 8133d43552 docs: Fix ESP TLS instructions to use wolfSSL The original command without `--recursive` did not clone the upstream wolfssl library which is included as a submodule since commit `901dd90f9a`. Using `--recursive` fixes this.		2023-06-06 15:40:34 +02:00
..
_static	spi_flash: Update documents for flash-suspend	2023-05-11 20:12:22 +08:00
docs_not_updated	docs: update esp32c6 api guides about wifi part	2023-05-31 15:20:40 +08:00
doxygen	docs: Update `nvs_flash` docs for the HMAC-based NVS encr-keys protection scheme	2023-05-23 13:55:57 +05:30
en	docs: Fix ESP TLS instructions to use wolfSSL	2023-06-06 15:40:34 +02:00
zh_CN	docs: Provide CN translation for api-reference/system/heap_debug.rst	2023-06-05 11:12:19 +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: update esp32c6 api guides about wifi part	2023-05-31 15:20:40 +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

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