esp-idf/docs
Krzysztof Budzynski c469316970 Merge branch 'docs/add_note_for_malloc_cap_dma_backport_v4.4' into 'release/v4.4'
docs: add note for MALLOC_CAP_DMA for ESP32-S2 according to customer feedback (backport v4.4)

See merge request espressif/esp-idf!17343
2022-03-10 17:10:10 +08:00
..
_static usb: Add USB Host Library documentation 2022-02-18 15:51:05 +08:00
doxygen
en Merge branch 'docs/add_note_for_malloc_cap_dma_backport_v4.4' into 'release/v4.4' 2022-03-10 17:10:10 +08:00
zh_CN docs: add note for MALLOC_CAP_DMA for ESP32-S2 according to customer feedback 2022-03-03 16:54:18 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py
doxygen-known-warnings.txt
generate_chart.py
page_redirects.txt
requirements.txt
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 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