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

History

daiziyan 9ba9dc04b0 docs: updated flash-encryption, startup, memory-types and misc_system_api		2023-03-07 18:06:52 +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	doc: initial parallel IO programming guide	2023-03-01 00:43:14 +00:00
en	docs: updated flash-encryption, startup, memory-types and misc_system_api	2023-03-07 18:06:52 +08:00
zh_CN	docs: updated flash-encryption, startup, memory-types and misc_system_api	2023-03-07 18:06:52 +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	doc: initial parallel IO programming guide	2023-03-01 00:43:14 +00:00
doxygen-known-warnings.txt	freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS	2022-12-23 15:29:17 +08:00
page_redirects.txt	freertos: Fix IDF FreeRTOS documentation redirect	2023-02-17 20:44:55 +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