esp-idf/docs
morris 9f18a0bb5b Merge branch 'doc/explain_ledc_callback_return_value' into 'master'
ledc: explain the callback return value

Closes IDFGH-8647

See merge request espressif/esp-idf!20916
2022-11-07 17:55:59 +08:00
..
_static dac: optimize the dma stratege 2022-10-25 17:14:59 +08:00
docs_not_updated twai: migrate example test to pytest 2022-10-31 21:44:08 +08:00
doxygen Merge branch 'feature/apply_new_version_logic' into 'master' 2022-11-04 16:01:32 +08:00
en Merge branch 'doc/explain_ledc_callback_return_value' into 'master' 2022-11-07 17:55:59 +08:00
zh_CN docs: update BluFi documentation 2022-11-07 13:11:20 +08:00
README.md
TEMPLATE_EXAMPLE_README.md docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +08:00
check_lang_folder_sync.sh
conf_common.py Docs: Update folder structure for 5.1 migration 2022-10-25 15:16:27 +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
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

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