esp-idf/docs
Mo Fei Fei d3f75c52d6 Merge branch 'docs/update_s3_devkitc1_user_guide' into 'master'
Docs: Update s3-devkitc-1 user guide

Closes DOC-2634

See merge request espressif/esp-idf!17582
2022-03-29 11:40:26 +08:00
..
_static docs: update s3-devkitc-1 user guide 2022-03-29 11:24:20 +08:00
docs_not_updated uart: Provide support for esp32c2 and esp32h2 2022-03-02 11:29:13 +08:00
doxygen docs: Add esp_tls_errors.h to API reference list 2022-03-25 07:31:41 +05:30
en Merge branch 'docs/update_s3_devkitc1_user_guide' into 'master' 2022-03-29 11:40:26 +08:00
zh_CN docs: update s3-devkitc-1 user guide 2022-03-29 11:24:20 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
TEMPLATE_EXAMPLE_README.md docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +08:00
check_lang_folder_sync.sh global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 2020-04-03 01:10:02 +02:00
conf_common.py docs: translate coexist from CN to EN 2022-03-09 02:50:00 +00:00
doxygen-known-warnings.txt
page_redirects.txt esp_netif: Remove tcpip_adapter compatibility layer 2022-03-10 08:19:43 +01:00
requirements.txt docs: update esp-docs, rename esp8684 to esp32c2 2022-01-21 09:26:35 +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