mofeifei 6b29118765 docs: sync up lines for api-guides and get-started 3 tahun lalu
..
_static a7f6f8677a doc: update api reference for new rmt driver 3 tahun lalu
docs_not_updated 407b693646 dedic_gpio: mention the overhead of using driver API 3 tahun lalu
doxygen a7f6f8677a doc: update api reference for new rmt driver 3 tahun lalu
en 6b29118765 docs: sync up lines for api-guides and get-started 3 tahun lalu
zh_CN 6b29118765 docs: sync up lines for api-guides and get-started 3 tahun lalu
README.md 7411321603 docs: update to use esp-docs 4 tahun lalu
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 4 tahun lalu
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 6 tahun lalu
conf_common.py 34211f898c Merge branch 'docs/update_esp_hid_device' into 'master' 3 tahun lalu
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 tahun lalu
page_redirects.txt 485cdd9a74 docs: add cn trans for system.rst 3 tahun lalu
requirements.txt 197be02748 docs: update esp-docs 1.0.0 3 tahun lalu
sphinx-known-warnings.txt a7f6f8677a doc: update api reference for new rmt driver 3 tahun lalu

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