esp-idf/docs
Ivan Grokhotkov a14e14f37a Merge branch 'feature/docker_build_gh_actions' into 'master'
ci: move Docker image builds to Github, plus other improvements

Closes IDFCI-1264 and IDFGH-6264

See merge request espressif/esp-idf!18256
2022-05-27 19:56:29 +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/docker_build_gh_actions' into 'master' 2022-05-27 19:56:29 +08:00
zh_CN Merge branch 'docs/fix_linker_script_table' into 'master' 2022-05-26 10:52:27 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
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
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