esp-idf/docs
Zim Kalinowski 2c9cd8e307 Merge branch 'feature/remove_target_cmake' into 'master'
build-system: remove target component

Closes IDF-3091 and IDF-3581

See merge request espressif/esp-idf!18131
2022-05-27 06:55:25 +08:00
..
_static doc: update api reference for new rmt driver 2022-05-07 10:34:50 +00:00
docs_not_updated dedic_gpio: mention the overhead of using driver API 2022-05-06 18:18:39 +08:00
doxygen esp_system: Update watchdog documentation 2022-05-18 20:12:25 +08:00
en Merge branch 'feature/remove_target_cmake' into 'master' 2022-05-27 06:55:25 +08:00
zh_CN Merge branch 'docs/fix_linker_script_table' into 'master' 2022-05-26 10:52:27 +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: update linkcheck configs 2022-05-07 13:09:41 +08:00
doxygen-known-warnings.txt docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
page_redirects.txt docs: add cn trans for system.rst 2022-04-20 13:07:38 +08:00
requirements.txt docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
sphinx-known-warnings.txt doc: move mqtt_client.h into known warnings 2022-05-18 16:28:19 +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