esp-idf/docs
Michael (XIAO Xufeng) a30375f335 Merge branch 'doc/auto_suspend_disabled_by_default' into 'master'
doc(flash): fix auto suspend enabled by default issue

See merge request espressif/esp-idf!30086
2024-04-15 23:48:37 +08:00
..
_static docs(jpeg): Add full-content of jpeg decoder and encoder programming guide 2024-04-11 10:22:01 +08:00
docs_not_updated doc(jtag): update esp32p4 jtag debugging guide 2024-04-04 21:37:56 +03:00
doxygen Merge branch 'feature/advanced_roaming_support' into 'master' 2024-04-02 00:02:41 +08:00
en Merge branch 'doc/auto_suspend_disabled_by_default' into 'master' 2024-04-15 23:48:37 +08:00
zh_CN Merge branch 'doc/auto_suspend_disabled_by_default' into 'master' 2024-04-15 23:48:37 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
component_info_ignore_file.txt
conf_common.py docs: disable build phy.rst for esp32p4 2024-04-01 14:59:57 +08:00
doxygen-known-warnings.txt
page_redirects.txt
sphinx-known-warnings.txt

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