esp-idf/docs
Mahavir Jain 11277bfdc5 Merge branch 'bugfix/remove_s3_dis_boot_remap_efuse_bit_v4.4' into 'release/v4.4'
docs: remove mention of DIS_BOOT_REMAP for chips other than ESP32-S2 (v4.4)

See merge request espressif/esp-idf!21810
2023-02-02 22:26:07 +08:00
..
_static
doxygen freemodbus: remove component files from esp-idf (backport v4.4) 2022-12-22 17:05:55 +08:00
en Merge branch 'bugfix/remove_s3_dis_boot_remap_efuse_bit_v4.4' into 'release/v4.4' 2023-02-02 22:26:07 +08:00
zh_CN docs: update cn trans for flash-encryptions 2023-01-04 21:33:40 +05:30
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py
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