esp-idf/docs
David Čermák 2e4d5d8765 Merge branch 'feature/add_eth_lost_ip_event' into 'master'
event: Add IP_EVENT_ETH_LOST_IP event

Closes IDFGH-5198

See merge request espressif/esp-idf!13466
2021-05-10 07:27:16 +00:00
..
_static docs: Update JTAG debugging guides for ESP32-C3 2021-04-13 12:48:50 +02:00
doxygen
en Merge branch 'feature/add_eth_lost_ip_event' into 'master' 2021-05-10 07:27:16 +00:00
extensions
idf_extensions
latex_templates
test
zh_CN
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py
check_lang_folder_sync.sh
conf_common.py
doxygen-known-warnings.txt
generate_chart.py
get_github_rev.py
page_redirects.txt
requirements.txt
sanitize_version.py
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 build requirements Python 3 and running the wrapper ./build_docs.py tool. Running ./build_docs.py --help will give a summary of available options.

See Documenting Code in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the ./build_docs.py tool.