morris 4478c13ea4 Merge branch 'docs_add_Chinese_translation_for_api-reference_peripherals/sdm.rst' into 'master' преди 2 години
..
_static 366ae76812 add low power doc and picture преди 2 години
docs_not_updated d29f31ec16 docs(openthread): update openthread README for H2 and C6 преди 2 години
doxygen 1037135761 docs: provided translation for storage.rst and system.rst and updated a typo for memory-types.rst преди 2 години
en 4478c13ea4 Merge branch 'docs_add_Chinese_translation_for_api-reference_peripherals/sdm.rst' into 'master' преди 2 години
zh_CN 4478c13ea4 Merge branch 'docs_add_Chinese_translation_for_api-reference_peripherals/sdm.rst' into 'master' преди 2 години
README.md 7411321603 docs: update to use esp-docs преди 4 години
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 преди 4 години
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs преди 6 години
conf_common.py d4ac2380e7 component/docs: enable generation of API-reference documents for Bluetooth HID host преди 2 години
doxygen-known-warnings.txt c318c89453 freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS преди 3 години
page_redirects.txt a44671c11a doc: remove left-over legacy event loop docs преди 3 години
sphinx-known-warnings.txt 2cf9236f6c heap trace standalone: Fix initialization of the unused linked list, update tests преди 3 години

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