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

History

Darian Leung 10ee81108f freertos(IDF): Update documentation on spinlock initialization and usage This commit adds some code snippets to covering how to initialize spinlocks when they are dynamically or statically allocated.		2022-12-08 22:05:14 +08:00
..
_static	doc: add api reference for etm driver	2022-11-23 15:32:34 +08:00
docs_not_updated	doc: add api reference for controller lcd drivers	2022-12-06 11:12:28 +08:00
doxygen	docs: Fix Doxyfile after esp_ds.h is merged	2022-11-24 16:03:30 +05:30
en	freertos(IDF): Update documentation on spinlock initialization and usage	2022-12-08 22:05:14 +08:00
zh_CN	Merge branch 'fix/docs-SYSVIEW_FreeRTOS_txt-path' into 'master'	2022-12-08 18:13:22 +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: add api reference for etm driver	2022-11-23 15:32:34 +08:00
doxygen-known-warnings.txt	docs: fix all doxygen warnings	2022-05-12 14:50:03 +08:00
page_redirects.txt	doc: redirect console page	2022-11-02 14:21:57 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt	fatfs: Add mock option to ff_sdmmc_status function to increase IO speed	2022-06-09 20:09:32 +00: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