morris 29c100b7b8 Merge branch 'docs_add_CN_translation_for_cotribute/copyright-guide.rst_and_install-pre-commit-book.rst' into 'master' 2 yıl önce
..
_static 366ae76812 add low power doc and picture 2 yıl önce
docs_not_updated d29f31ec16 docs(openthread): update openthread README for H2 and C6 2 yıl önce
doxygen 1037135761 docs: provided translation for storage.rst and system.rst and updated a typo for memory-types.rst 2 yıl önce
en 29c100b7b8 Merge branch 'docs_add_CN_translation_for_cotribute/copyright-guide.rst_and_install-pre-commit-book.rst' into 'master' 2 yıl önce
zh_CN 29c100b7b8 Merge branch 'docs_add_CN_translation_for_cotribute/copyright-guide.rst_and_install-pre-commit-book.rst' into 'master' 2 yıl önce
README.md 7411321603 docs: update to use esp-docs 4 yıl önce
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 4 yıl önce
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 yıl önce
conf_common.py d4ac2380e7 component/docs: enable generation of API-reference documents for Bluetooth HID host 2 yıl önce
doxygen-known-warnings.txt c318c89453 freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS 3 yıl önce
page_redirects.txt a44671c11a doc: remove left-over legacy event loop docs 2 yıl önce
sphinx-known-warnings.txt ebde53bbb9 docs(fatfs): Move mentioned APIs to a separate API reference section 2 yıl önce

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