mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00

History

Marius Vikhammer 22b13112b6 docs: reorder content in mem_alloc section We should avoid hiding sections between long lists of API documentation.		2022-09-05 13:46:08 +08:00
..
_static	docs: fix missing static file path	2022-03-03 10:48:20 +08:00
doxygen	temperature sensor: Add support on ESP32-S3,	2022-07-13 17:22:59 +08:00
en	docs: reorder content in mem_alloc section	2022-09-05 13:46:08 +08:00
zh_CN	Docs: update the JTAG select eFuse description in configure-other-jtag.rst (backport v4.4)	2022-08-30 11:06:57 +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: fix all doxygen warnings	2022-07-05 11:14:40 +08:00
doxygen-known-warnings.txt	docs: fix all doxygen warnings	2022-07-05 11:14:40 +08:00
generate_chart.py	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
page_redirects.txt	ulp: Added support for ULP FSM on esp32s3 and fixed bugs for esp32s2	2022-06-29 11:57:02 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
requirements.txt	docs: fix all doxygen warnings	2022-07-05 11:14:40 +08:00
sphinx-known-warnings.txt	component_bt: Fix build doc errors of bt	2022-08-02 13:39:36 +08:00
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +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