esp-idf/docs
Mo Fei Fei 2934010950 Merge branch 'docs/sync_up_cn_trans_user_guides' into 'master'
docs: sync up cn trans for esp32-devkitc and esp32-s2-kaluga-1-kit user guides

Closes DOC-2403 and DOC-2388

See merge request espressif/esp-idf!16360
2021-12-13 06:36:33 +00:00
..
_static docs:update ESP32-DevKitC Pin Layout figure of higher resolution 2021-12-09 19:34:34 +08:00
doxygen esp_ipc: Update documentation and API descriptions 2021-11-18 21:34:50 +08:00
en Merge branch 'docs/sync_up_cn_trans_user_guides' into 'master' 2021-12-13 06:36:33 +00:00
zh_CN Merge branch 'docs/sync_up_cn_trans_user_guides' into 'master' 2021-12-13 06:36:33 +00:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Merge branch 'bugfix/html_redirect' into 'master' 2021-12-06 03:57:33 +00:00
doxygen-known-warnings.txt
generate_chart.py style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
page_redirects.txt doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
requirements.txt docs: bump esp-docs version to 0.1.1 2021-09-06 14:55:04 +08:00
sphinx-known-warnings.txt docs: ignore duplicate def warning in BT docs 2021-06-30 15:10:43 +08:00

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