mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
594e58e65a
- include headers from the tlsf submodule only when CONFIG_HEAP_TLSF_USE_ROM_IMPL is not set - remove usage of the tlsf_t type in the multi_heap.c - add missing declaration of tlsf_poison_fill_pfunc_set() in multi_heap_poisoning.c - define headers from tlsf submodule as private - update the linker file in the heap component to the new naming of the tlsf file - update the copyright docuementation to reference the submodule in github (https://github.com/espressif/tlsf) - remove deleted files from the check_copyright_ignore.txt
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
- English: https://docs.espressif.com/projects/esp-idf/en/latest/
- 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
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