esp-idf/docs
2023-10-11 17:54:27 +08:00
..
_static feat(cache): added cache msync doc 2023-09-28 15:53:19 +08:00
docs_not_updated feat(spi_master): p4 document update 2023-10-08 14:46:04 +08:00
doxygen Merge branch 'docs/show_include_path' into 'master' 2023-10-11 09:36:14 +08:00
en revert(lwip): Revert changes to LWIP task priority macro from MR 25020 2023-10-11 17:54:27 +08:00
zh_CN revert(lwip): Revert changes to LWIP task priority macro from MR 25020 2023-10-11 17:54:27 +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
component_info_ignore_file.txt docs(build): add header include path and component require to api reference 2023-10-07 11:47:45 +08:00
conf_common.py Merge branch 'docs/show_include_path' into 'master' 2023-10-11 09:36:14 +08:00
doxygen-known-warnings.txt feat(mqtt): Updates submodule to 05b3476 2023-09-04 15:33:34 +02:00
page_redirects.txt doc: remove left-over legacy event loop docs 2023-03-17 15:37:26 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt fix(ble_mesh): Miscellaneous update for ble mesh 2023-09-16 15:58:14 +08:00
TEMPLATE_EXAMPLE_README.md docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +08:00

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