esp-idf/docs
Marius Vikhammer d485f6add8 Merge branch 'feature/arch_build_property' into 'master'
build-system: add property for architecture (riscv/xtensa)

Closes IDF-1754

See merge request espressif/esp-idf!18127
2022-05-24 08:46:09 +08:00
..
_static
docs_not_updated
doxygen esp_system: Update watchdog documentation 2022-05-18 20:12:25 +08:00
en Merge branch 'feature/arch_build_property' into 'master' 2022-05-24 08:46:09 +08:00
zh_CN Merge branch 'feature/target_kconfig_movement_3' into 'master' 2022-05-24 08:45:01 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py
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