esp-idf/docs
Dai Zi Yan 8c23e4ebab Merge branch 'docs/update_CN_trans_memory_type' into 'master'
docs: updated CN trans for memory-types

Closes DOC-2347

See merge request espressif/esp-idf!16370
2022-01-10 03:31:32 +00:00
..
_static usb: Add USB Host Library documentation 2022-01-06 15:15:32 +08:00
docs_not_updated Merge branch 'docs/esp8684_frontpages' into 'master' 2022-01-04 08:47:42 +00:00
doxygen doc: API reference for GPTimer 2022-01-07 14:59:09 +08:00
en Merge branch 'docs/update_CN_trans_memory_type' into 'master' 2022-01-10 03:31:32 +00:00
zh_CN docs: updated CN trans for memory-types and external-ram 2022-01-08 15:21:17 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py docs: fix missing static file path 2021-12-29 13:57:30 +08:00
doxygen-known-warnings.txt
generate_chart.py
page_redirects.txt
requirements.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