esp-idf/docs
Wang Fang a8aead1986 Merge branch 'docs/update_ide_documentation' into 'master'
docs: deleted IDE documentation and provided links to these IDE GitHub repos

Closes DOC-3254, DOC-2982, and DOC-2961

See merge request espressif/esp-idf!18627
2022-07-08 09:35:13 +08:00
..
_static i2s: update documents for driver-NG 2022-06-15 10:30:04 +08:00
docs_not_updated doc: esp32c2 wifi programming guide doc. 2022-07-07 14:13:11 +08:00
doxygen Merge branch 'component/mdns_migration' into 'master' 2022-07-04 17:45:27 +08:00
en Merge branch 'docs/update_ide_documentation' into 'master' 2022-07-08 09:35:13 +08:00
zh_CN Merge branch 'docs/update_ide_documentation' into 'master' 2022-07-08 09:35:13 +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: esp32c2 wifi programming guide doc. 2022-07-07 14:13:11 +08:00
doxygen-known-warnings.txt docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
page_redirects.txt docs: deleted IDE documentation and provided links to these IDE GitHub repos 2022-07-07 18:14:26 +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-05-12 14:50:03 +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

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