esp-idf/docs
morris bc56ae4a63 Merge branch 'docs/translate_uart' into 'master'
docs: translate uart

Closes DOC-3037

See merge request espressif/esp-idf!21184
2022-12-08 19:34:40 +08:00
..
_static doc: add api reference for etm driver 2022-11-23 15:32:34 +08:00
docs_not_updated doc: add api reference for controller lcd drivers 2022-12-06 11:12:28 +08:00
doxygen docs: Fix Doxyfile after esp_ds.h is merged 2022-11-24 16:03:30 +05:30
en Merge branch 'docs/translate_uart' into 'master' 2022-12-08 19:34:40 +08:00
zh_CN Merge branch 'docs/translate_uart' into 'master' 2022-12-08 19:34:40 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py doc: add api reference for etm driver 2022-11-23 15:32:34 +08:00
doxygen-known-warnings.txt
page_redirects.txt doc: redirect console page 2022-11-02 14:21:57 +08:00
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