History

lly 7cd08b5824 ble_mesh: Miscellaneous modifications 1. Add an API to set Provisioner static oob value 2. Add an API to deinit BLE Mesh stack 3. Add an API to set Provisioner unicast address 4. Add an API to provision devices with fixed address 5. Add an API to store node composition data 6. Add an API to get node with device uuid 7. Add an API to get node with unicast address 8. Add an API to delete node with device uuid 9. Add an API to delete node with unicast address 10. Add an API for Provisioner to update local AppKey 11. Add an API for Provisioner to update local NetKey 12. Support Provisioner persistent functionality 13. Fix Provisioner entering IV Update procedure 14. Fix an issue which may cause client failing to send msg 15. Use bt_mesh.flags to indicate device role 16. Remove several useless macros 17. Callback RSSI of received mesh provisioning packets 18. Modify the Provisioner disable function 19. Change some log level from debug to info 20. Add parameters to Provisioner bind AppKey completion event 21. Fix node ignoring relay messages issue 22. Support using a specific partition for BLE Mesh 23. Fix compile warning when proxy related macros are disabled 24. Clean up BLE Mesh stack included header files 25. NULL can be input if client message needs no parameters 26. Fix compile warning when BT log is disabled 27. Initilize BLE Mesh stack local variables 28. Support using PSRAM for BLE Mesh mutex, queue and task 29. Add a menuconfig option to enable using memory from PSRAM 30. Clean up sdkconfig.defaults of BLE Mesh examples		2020-02-26 17:37:44 +08:00
..
_static	docs: add API guide page about IDF Tools	2020-01-24 14:02:21 +01:00
en	ble_mesh: Miscellaneous modifications	2020-02-26 17:37:44 +08:00
extensions	doc: Changed toc filter reg.ex to be non-greedy	2020-02-07 16:37:43 +11:00
idf_extensions	docs: Check local files exist (and are correct type) for custom link roles	2020-02-18 10:34:11 +11:00
zh_CN	ble_mesh: Miscellaneous modifications	2020-02-26 17:37:44 +08:00
build_docs.py	bugfix/build_docs_add_warning_check: Added null value check for warnings	2020-02-12 12:32:41 +05:30
check_lang_folder_sync.sh	Revert "docs: Temporarily allow cmake docs to be in English only"	2018-05-07 18:45:49 +08:00
conf_common.py	docs: Move to Python 3.5+ and Sphinx 2.3	2020-02-07 16:47:50 +11:00
Doxyfile	soc: separate abstraction, description and implementation	2020-02-11 14:30:42 +05:00
doxygen-known-warnings.txt	docs: Resolve doxygen & Sphinx warnings	2020-02-07 16:37:45 +11:00
page_redirects.txt	esp_netif: docs update to include tcpip_adapter migration guide	2019-11-25 08:32:11 +01:00
README.md	docs: Move to Python 3.5+ and Sphinx 2.3	2020-02-07 16:47:50 +11:00
requirements.txt	docs: Move to Python 3.5+ and Sphinx 2.3	2020-02-07 16:47:50 +11:00
sphinx-known-warnings.txt	docs: Resolve doxygen & Sphinx warnings	2020-02-07 16:37:45 +11:00
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +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

Documentation build requres Python 3 and will not work with Python 2
Install dependencies for ESP-IDF as per the Getting Started guide
Install documentation Python depdendencies, ie pip install -r $IDF_PATH/docs/requirements.txt
Run ./build_docs.py build to build docs for all supported Language & Target combinations, or ./build_docs.py -t esp32 -l en build to build docs for a single supported language & target combination only.

See Documenting Code for more information.

Available languages are en and zh_CN, targets are any target supported by ESP-IDF - for example esp32 or esp32s2.