esp-idf/docs
Roland Dobai f4d1bb017a Merge branch 'feature/add-wl-support-fatfs' into 'master'
Add wear levelling support for fatfs partition generator

Closes IDF-4043 and IDF-2053

See merge request espressif/esp-idf!15798
2021-12-01 14:21:39 +00:00
..
_static Doc/add esp32s3 kevkitm 1 user guide cn and en 2021-11-17 11:13:34 +00:00
doxygen esp_ipc: Update documentation and API descriptions 2021-11-18 21:34:50 +08:00
en Merge branch 'feature/add-wl-support-fatfs' into 'master' 2021-12-01 14:21:39 +00:00
zh_CN other: Move cbor, jsmn and libsodium to idf-component-manager 2021-11-30 21:44:48 +01:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Build & config: Remove the "make" build system 2021-11-10 09:53:53 +01:00
doxygen-known-warnings.txt
generate_chart.py
page_redirects.txt doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
requirements.txt docs: bump esp-docs version to 0.1.1 2021-09-06 14:55:04 +08:00
sphinx-known-warnings.txt docs: ignore duplicate def warning in BT docs 2021-06-30 15:10:43 +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