mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
b5bafae596
GDB now is standalone tool separated from toolchain due to frequent updates. Added installation tests for the new tool. Tests are changed because they were wrong, see explanation: esp32 objdump: 40084290 <esp_crosscore_int_send_yield>: ...... /builds/espressif/esp-idf/components/esp_system/crosscore_int.c:145 4008429c: 000090 retw With previous GDB backtrace was: #0 0x4008429c in esp_crosscore_int_send_yield (core_id=0) at /builds/espressif/esp-idf/components/esp_system/crosscore_int.c:144 This commit fixes the backtrace with the right line number: #0 0x4008429c in esp_crosscore_int_send_yield (core_id=0) at /builds/espressif/esp-idf/components/esp_system/crosscore_int.c:145 Other tests changes have the same cause of fixing. Closes https://github.com/espressif/esp-idf/issues/6334 |
||
---|---|---|
.. | ||
_static | ||
docs_not_updated | ||
doxygen | ||
en | ||
zh_CN | ||
check_lang_folder_sync.sh | ||
conf_common.py | ||
doxygen-known-warnings.txt | ||
page_redirects.txt | ||
README.md | ||
requirements.txt | ||
sphinx-known-warnings.txt | ||
TEMPLATE_EXAMPLE_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
- 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