Simon e4d85807ea Merge branch 'feature/spi_flash_esp8684_support' into 'master' 3 lat temu
..
_static 57ac6d4673 docs: update s3-devkitc-1 user guide 3 lat temu
docs_not_updated 9fdf39651b freemodbus: remove component files from esp-idf (fix examples) 3 lat temu
doxygen 197be02748 docs: update esp-docs 1.0.0 3 lat temu
en e4d85807ea Merge branch 'feature/spi_flash_esp8684_support' into 'master' 3 lat temu
zh_CN 2ddcb13509 docs: add documentation about reproducible builds 3 lat temu
README.md 7411321603 docs: update to use esp-docs 4 lat temu
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 4 lat temu
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 lat temu
conf_common.py 6514f9e94c docs: translate coexist from CN to EN 4 lat temu
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 lat temu
page_redirects.txt 485cdd9a74 docs: add cn trans for system.rst 3 lat temu
requirements.txt 197be02748 docs: update esp-docs 1.0.0 3 lat temu
sphinx-known-warnings.txt 197be02748 docs: update esp-docs 1.0.0 3 lat temu

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